This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author terry.reedy
Recipients Patrick Lehmann, docs@python, georg.brandl, lukasz.langa, r.david.murray, terry.reedy
Date 2018-06-18.01:45:51
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <>
In my last comment above, I forgot that this issue is about *docstrings*.  We do not officially process docstrings with Sphinx, so there are no warnings to be suppressed.

PEP 8, which covers style for the stdlib, refers to
Neither says anything about markup and last I remember, there should not be any for the stdlib. Pep-0257 gives this example:

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real -- the real part (default 0.0)
    imag -- the imaginary part (default 0.0)
Here, parameter names are indicated by the formatting, not by markup.  If `' is used in such lists, it should just be deleted.  I believe 'name' is sometimes used in running text.

The help() function prints a docstring as is.
Date User Action Args
2018-06-18 01:45:52terry.reedysetrecipients: + terry.reedy, georg.brandl, r.david.murray, docs@python, lukasz.langa, Patrick Lehmann
2018-06-18 01:45:52terry.reedysetmessageid: <>
2018-06-18 01:45:52terry.reedylinkissue28710 messages
2018-06-18 01:45:51terry.reedycreate