Message319848
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 https://www.python.org/dev/peps/pep-0257/
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:52 | terry.reedy | set | recipients:
+ terry.reedy, georg.brandl, r.david.murray, docs@python, lukasz.langa, Patrick Lehmann |
2018-06-18 01:45:52 | terry.reedy | set | messageid: <1529286352.31.0.56676864532.issue28710@psf.upfronthosting.co.za> |
2018-06-18 01:45:52 | terry.reedy | link | issue28710 messages |
2018-06-18 01:45:51 | terry.reedy | create | |
|