-
-
Notifications
You must be signed in to change notification settings - Fork 31.2k
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
Comments
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. |
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 :) |
…ythonGH-130174) (cherry picked from commit 9837c2a) Co-authored-by: Stan Ulbrych <[email protected]>
…ythonGH-130174) (cherry picked from commit 9837c2a) Co-authored-by: Stan Ulbrych <[email protected]>
@sobolevn You forgot to close the issue, also apologies for the PR, I should have waited. |
Thanks @StanFromIreland and @sobolevn ! |
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?
cpython/Doc/c-api/function.rst
Lines 146 to 155 in 798f8d3
Linked PRs
Doc/c-api/function.rst
(GH-130174) #130175Doc/c-api/function.rst
(GH-130174) #130176The text was updated successfully, but these errors were encountered: