Repository navigation
Improve faq/design.rst rst markup #96265
Description
I noticed that the faq/design.rst page 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.
Activity
slateny commentedon Sep 19, 2022
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?CAM-Gerlach commentedon Sep 19, 2022
File by file, I'd say, if we're going through them, unless that's the only change needed in the file
gh-96265: Fix some formatting in faq/design.rst (#96924)
Merge branch 'main' into typewatch
pythongh-96265: Fix some formatting in faq/design.rst (python#96924)
gh-96265: Formatting changes for faq/general (#98129)
pythongh-96265: Formatting changes for faq/general (pythonGH-98129)
pythongh-96265: Formatting changes for faq/general (pythonGH-98129)
gh-96265: Formatting changes for faq/general (GH-98129)
gh-96265: Formatting changes for faq/general (GH-98129)
Merge branch 'main' into typewatch
Merge branch 'main' into cached_property
gh-96265: Formatting changes for faq/general (GH-98129)
gh-96265: Formatting changes for faq/programming (#98242)
pythongh-96265: Formatting changes for faq/programming (pythonGH-98242)
gh-96265: Formatting changes for faq/programming (GH-98242)
[3.10] pythongh-96265: Formatting changes for faq/programming (python…
[3.10] gh-96265: Formatting changes for faq/programming (GH-98242) (#…
hauntsaninja commentedon Mar 25, 2023
Thanks, closing. We can open another issue for any other FAQs