Description

ezio-melotti

opened on Aug 25, 2022

Issue body actions

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.

• PR: [3.11] gh-96265: Formatting changes for faq/programming (GH-98242) #98991

• PR: [3.10] gh-96265: Formatting changes for faq/programming (GH-98242) #98994

Activity

1. ezio-melotti

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Aug 25, 2022
2. slateny commented on Sep 19, 2022

   

   slateny

   on Sep 19, 2022

   Contributor

   More actions

   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.C etc. could be literal), but changes to design.rst are 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?
3. CAM-Gerlach commented on Sep 19, 2022

   

   CAM-Gerlach

   on Sep 19, 2022

   Member

   More actions

   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
4. CAM-Gerlach

   assigned

   slateny

   on Sep 19, 2022
5. ambv

   added a commit that references this issue on Oct 7, 2022

   gh-96265: Fix some formatting in faq/design.rst (#96924)

   3a7e955
6. carljm

   added a commit that references this issue on Oct 8, 2022

   Merge branch 'main' into typewatch

   27a4980
7. mpage

   added a commit that references this issue on Oct 11, 2022

   pythongh-96265: Fix some formatting in faq/design.rst (python#96924)

   53bc2db
8. ezio-melotti

   added a commit that references this issue on Oct 12, 2022

   gh-96265: Formatting changes for faq/general (#98129)

   e9569ec
9. miss-islington

   added 4 commits that reference this issue on Oct 12, 2022

   pythongh-96265: Formatting changes for faq/general (pythonGH-98129)

   d3b86f8

   pythongh-96265: Formatting changes for faq/general (pythonGH-98129)

   0ba2196

   gh-96265: Formatting changes for faq/general (GH-98129)

   258c440

   gh-96265: Formatting changes for faq/general (GH-98129)

   450306e
10. carljm

    added 2 commits that reference this issue on Oct 14, 2022

    Merge branch 'main' into typewatch

    6e53514

    Merge branch 'main' into cached_property

    0bb0c69
11. pablogsal

    added a commit that references this issue on Oct 22, 2022

    gh-96265: Formatting changes for faq/general (GH-98129)

    0f3c5ab
12. ezio-melotti

    added a commit that references this issue on Nov 2, 2022

    gh-96265: Formatting changes for faq/programming (#98242)

    0689b99
13. miss-islington

    added 2 commits that reference this issue on Nov 2, 2022

    pythongh-96265: Formatting changes for faq/programming (pythonGH-98242)

    4a30220

    gh-96265: Formatting changes for faq/programming (GH-98242)

    d683bcc
14. slateny

    added a commit that references this issue on Nov 2, 2022

    [3.10] pythongh-96265: Formatting changes for faq/programming (python…

    28567d0
15. ezio-melotti

    added a commit that references this issue on Nov 3, 2022

    [3.10] gh-96265: Formatting changes for faq/programming (GH-98242) (#…

    c592b33
16. hauntsaninja commented on Mar 25, 2023

    

    hauntsaninja

    on Mar 25, 2023

    Contributor

    More actions

    Thanks, closing. We can open another issue for any other FAQs
17. hauntsaninja

    closed this as completedon Mar 25, 2023

Issue actions