Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork33.7k
Closed
Description
Bug report
The docstring ofenum.Enum is invalid in reStructuredText since 3.11.
$ python3.11 ~/work/tmp/docPython 3.11.0a7+ (heads/main:ad5e852, May 2 2022, 01:40:38) [Clang 11.0.3 (clang-1103.0.32.62)] on darwinType "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.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
- CPython versions tested on: Python 3.11.0a7+ (heads/main:ad5e852, May 2 2022, 01:40:38)
- Operating system and architecture: macOS 10.15