Thanks to visit codestin.com
Credit goes to github.com

Skip to content

The docstring of enum.Enum is invalid in reStructuredText since 3.11 #92120

Closed
@tk0miya

Description

@tk0miya

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

  • CPython versions tested on: Python 3.11.0a7+ (heads/main:ad5e852, May 2 2022, 01:40:38)
  • Operating system and architecture: macOS 10.15

Linked PRs

Metadata

Metadata

Assignees

Labels

3.11only security fixesstdlibPython modules in the Lib dirtype-bugAn unexpected behavior, bug, or error

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions