[issue37134] Use PEP570 syntax in the documentation

Pablo Galindo Salgado report at bugs.python.org
Sun Jun 2 12:18:06 EDT 2019


New submission from Pablo Galindo Salgado <pablogsal at gmail.com>:

In the documentation, there are a lot of mismatches regarding function and method signatures that use positional-only arguments with respect to the docstrings (that properly use PEP570 syntax for documenting positional-only parameters).

Not that the official syntax for positional-only parameters is accepted (the "/"), the documentation needs to be updated to reflect positional-only parameters in the functions and methods that use them as covered in the PEP document.

----------
assignee: docs at python
components: Documentation
messages: 344295
nosy: docs at python, pablogsal
priority: normal
severity: normal
status: open
title: Use PEP570 syntax in the documentation
versions: Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue37134>
_______________________________________


More information about the Python-bugs-list mailing list