Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possibly unnumbered list missing in Doc/c-api/function.rst #130169

Closed
rffontenelle opened this issue Feb 16, 2025 · 4 comments
Closed

Possibly unnumbered list missing in Doc/c-api/function.rst #130169

rffontenelle opened this issue Feb 16, 2025 · 4 comments
Labels
docs Documentation in the Doc dir easy

Comments

@rffontenelle
Copy link
Contributor

rffontenelle commented Feb 16, 2025

Documentation

PyFunction_WatchEvent at c-api/function.rst has in the source file what seems to be a unnumbered list, but the built documentation has everything in a single line. Should it be formatted as a unnumbered list instead?

.. c:type:: PyFunction_WatchEvent
Enumeration of possible function watcher events:
- ``PyFunction_EVENT_CREATE``
- ``PyFunction_EVENT_DESTROY``
- ``PyFunction_EVENT_MODIFY_CODE``
- ``PyFunction_EVENT_MODIFY_DEFAULTS``
- ``PyFunction_EVENT_MODIFY_KWDEFAULTS``
.. versionadded:: 3.12

Image

Linked PRs

@rffontenelle rffontenelle added the docs Documentation in the Doc dir label Feb 16, 2025
@terryjreedy
Copy link
Member

The current presentation looks plausible to me since the meaning of each event is pretty clear from the name. The stat doc has several unnumbered lists. Most annotate each item, but the two lists for Windows do not and also give 1 item per line. I do not know what other docs do when annotation is not needed.

@sobolevn
Copy link
Member

It should be:

    Enumeration of possible function watcher events:

    - ``PyFunction_EVENT_CREATE`` 
    - ``PyFunction_EVENT_DESTROY`` 
    - ``PyFunction_EVENT_MODIFY_CODE`` 
    - ``PyFunction_EVENT_MODIFY_DEFAULTS`` 
    - ``PyFunction_EVENT_MODIFY_KWDEFAULTS`` 
  

PR is welcome :)

@sobolevn sobolevn added the easy label Feb 16, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 16, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 16, 2025
sobolevn pushed a commit that referenced this issue Feb 16, 2025
…H-130174) (#130175)

gh-130169: Fix broken list markup in `Doc/c-api/function.rst` (GH-130174)
(cherry picked from commit 9837c2a)

Co-authored-by: Stan Ulbrych <[email protected]>
sobolevn pushed a commit that referenced this issue Feb 16, 2025
…H-130174) (#130176)

gh-130169: Fix broken list markup in `Doc/c-api/function.rst` (GH-130174)
(cherry picked from commit 9837c2a)

Co-authored-by: Stan Ulbrych <[email protected]>
@StanFromIreland
Copy link
Contributor

@sobolevn You forgot to close the issue, also apologies for the PR, I should have waited.

@rffontenelle
Copy link
Contributor Author

Thanks @StanFromIreland and @sobolevn !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir easy
Projects
Status: Todo
Development

No branches or pull requests

4 participants