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 vstinner
Recipients barry, brett.cannon, bskinn, docs@python, grantjenks, gregory.p.smith, ncoghlan, p-ganssle, pablogsal, rhettinger, tim.peters, vstinner, willingc
Date 2019-06-04.21:28:08
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1559683688.64.0.720557853959.issue37134@roundup.psfhosted.org>
In-reply-to
Content
Python has many parameter types: positional-only, positional-or-keyword, keyword only, etc. Even if we don't add "/", it would be nice to have hints when we put the mouse cursor on a function parameter.

Something like:

function: demo(arg1, *, arg2, arg3=None)

arg1 hint: *arg1* is the first mandatory parameter (kind: positional-or-keyword)
arg2 hint: *arg2* is the second mandatory parameter (kind: keyword-only)
arg3 hint: *arg3* is an optional parameter (default: ``None``, kind: keyword-only)

Maybe we can also add hints on '*':

* hint: Marker for keyword-only parameter

... I have no idea how complex it would be to implement such Sphinx extenstion, or maybe even implement it in Sphinx.
History
Date User Action Args
2019-06-04 21:28:08vstinnersetrecipients: + vstinner, tim.peters, barry, brett.cannon, rhettinger, gregory.p.smith, ncoghlan, docs@python, willingc, bskinn, p-ganssle, pablogsal, grantjenks
2019-06-04 21:28:08vstinnersetmessageid: <1559683688.64.0.720557853959.issue37134@roundup.psfhosted.org>
2019-06-04 21:28:08vstinnerlinkissue37134 messages
2019-06-04 21:28:08vstinnercreate