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 eric.araujo
Recipients docs@python, eric.araujo, fredg1
Date 2020-12-14.14:34:02
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <>
Thank you for the details!  This helps finding a good place to document this.
A link to function parameters from the top of the section may be good.
But maybe we need a sidebar link on all pages that goes to a description of doc conventions! (and includes link to basic syntax doc, function parameter glossary, tutorial).

(As you thought, there are notations in the docs (and even in some docstrings) that are documentation conventions but not valid Python, such as "range(start, stop[, step]) -> range object")

Even the enty for '* (asterisk)' in the general index links to places explaining *args, not * alone.

I agree that the glossary entry for parameter is the best place to link to: it’s short and complete and can link to language reference for more.
Date User Action Args
2020-12-14 14:34:02eric.araujosetrecipients: + eric.araujo, docs@python, fredg1
2020-12-14 14:34:02eric.araujosetmessageid: <>
2020-12-14 14:34:02eric.araujolinkissue42571 messages
2020-12-14 14:34:02eric.araujocreate