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
enum.Enum
Bug report
The docstring of enum.Enum is invalid in reStructuredText since 3.11.
$ python3.11 ~/work/tmp/doc Python 3.11.0a7+ (heads/main:ad5e852, May 2 2022, 01:40:38) [Clang 11.0.3 (clang-1103.0.32.62)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>> import enum >>> print(enum.Enum.__doc__) (snip) - attribute access:: >>> Color.RED <Color.RED: 1> (snip) >>>
The "attribute access" line ends with a code-block marker "::". But no code-block follows.
As a result, Sphinx emits a warning for the subclasses of Enum as following:
/Users/tkomiya/work/tmp/doc/example.py:docstring of example.Transpose:7: WARNING: Literal block expected; none found.
refs: sphinx-doc/sphinx#10410
Additionally, the bullet list is interrupted by code-blocks. IMO, these code-blocks should be indented to the item level of the bullet list.
Your environment
The text was updated successfully, but these errors were encountered:
pythongh-92120: The docstring of enum.Enum is invalid in reST
d95098e
Closes python#92120
gh-92120: The docstring of enum.Enum is invalid in reST (GH-92122)
90d5c9b
Closes #92120
ethanfurman
Successfully merging a pull request may close this issue.
tk0miya commentedMay 1, 2022
•
edited by bedevere-bot
Bug report
The docstring of
enum.Enum
is invalid in reStructuredText since 3.11.The "attribute access" line ends with a code-block marker "::". But no code-block follows.
As a result, Sphinx emits a warning for the subclasses of Enum as following:
refs: sphinx-doc/sphinx#10410
Additionally, the bullet list is interrupted by code-blocks. IMO, these code-blocks should be indented to the item level of the bullet list.
Your environment
Linked PRs
The text was updated successfully, but these errors were encountered: