Message 241590 - Python tracker

➜

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.

In-reply-to
Author	martin.panter
Recipients	baptiste.carvello, chris.jerdonek, docs@python, eric.araujo, eric.smith, eric.snow, ezio.melotti, georg.brandl, martin.panter, petri.lehtinen, terry.reedy
Date	2015年04月20日.02:25:31
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1429496731.21.0.238462293514.issue13386@psf.upfronthosting.co.za>

Content
When a parameter is optional but does not have a simple default value, I suggest using some obviously invalid pseudocode, such as function(arg1, arg2=<automatic, see text>) See Issue 8706 about adding more support for keyword arguments. See also Issue 23738 for signatures that incorrectly appear to accept keywords due to including default values, and PEP 457’s slash (/) indicator for documenting positional-only parameters.

Content

When a parameter is optional but does not have a simple default value, I suggest using some obviously invalid pseudocode, such as
function(arg1, arg2=<automatic, see text>)
See Issue 8706 about adding more support for keyword arguments. See also Issue 23738 for signatures that incorrectly appear to accept keywords due to including default values, and PEP 457’s slash (/) indicator for documenting positional-only parameters.

History
Date	User	Action	Args
2015年04月20日 02:25:31	martin.panter	set	recipients: + martin.panter, georg.brandl, terry.reedy, eric.smith, ezio.melotti, eric.araujo, chris.jerdonek, docs@python, eric.snow, baptiste.carvello, petri.lehtinen
2015年04月20日 02:25:31	martin.panter	set	messageid: <1429496731.21.0.238462293514.issue13386@psf.upfronthosting.co.za>
2015年04月20日 02:25:31	martin.panter	link	issue13386 messages
2015年04月20日 02:25:31	martin.panter	create

homepage