Skip to content

Improve faq/design.rst rst markup #96265

Description

@ezio-melotti

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

  1. slateny commented on Sep 19, 2022

    @slateny
    Contributor

    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?

  2. CAM-Gerlach commented on Sep 19, 2022

    @CAM-Gerlach
    Member

    File by file, I'd say, if we're going through them, unless that's the only change needed in the file

  3. added a commit that references this issue on Oct 7, 2022
  4. added a commit that references this issue on Oct 8, 2022
  5. added a commit that references this issue on Oct 11, 2022
  6. added a commit that references this issue on Oct 12, 2022
  7. added 4 commits that reference this issue on Oct 12, 2022
  8. added a commit that references this issue on Oct 22, 2022
  9. added a commit that references this issue on Nov 2, 2022
  10. added 2 commits that reference this issue on Nov 2, 2022
  11. added a commit that references this issue on Nov 2, 2022
  12. added a commit that references this issue on Nov 3, 2022
  13. hauntsaninja commented on Mar 25, 2023

    @hauntsaninja
    Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions