Repository navigation
Improve faq/design.rst rst markup #96265
Copy link
Copy link
Closed
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir
Description
Activity
Created a PR for just
design.rst- as for other FAQs, I think the general faq could get some grave accents too (maybe under 'version numbering',A.B.Cetc. could be literal), but changes todesign.rstare looking somewhat long already so I'll put them in a separate PR.Some of the missing formatting can also be found in other docs (i.e.,
``if``->:keyword:`if`), should those be globally applied or should it change file-by-file?File by file, I'd say, if we're going through them, unless that's the only change needed in the file
Reacted by Ezio Melotti and Stanley- added a commit that references this issue
on Oct 7, 2022 - added a commit that references this issue
on Oct 8, 2022 - added a commit that references this issue
on Oct 12, 2022 - added 4 commits that reference this issue
on Oct 12, 2022 - added 2 commits that reference this issue
on Oct 14, 2022 - added a commit that references this issue
on Oct 22, 2022 - added a commit that references this issue
on Nov 2, 2022 Thanks, closing. We can open another issue for any other FAQs
Metadata
Metadata
Assignees
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir
I noticed that the
faq/design.rstpage has several parts that either have no markup (e.g. try/except, :=, etc.) or a generic``...``when a more specific one could be used (e.g.:c:type:`double`).We should review the page and apply proper markup where applicable. Some other FAQs might need the same treatment.