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 bethard, docs@python, eric.araujo, flox, petri.lehtinen, roysmith, santoso.wijaya, terry.reedy
Date 2011-11-14.16:58:10
SpamBayes Score 7.0493624e-09
Marked as misclassified No
Message-id <1321289891.78.0.333370554336.issue13249@psf.upfronthosting.co.za>
In-reply-to
Content
I would not use a note directive.  Notes and warnings distract and sometimes scare readers.  For a simple coding recommendation like this, I think a regular paragraph would suffice.  To make sure it’s not lost after pages of options description, maybe it could be put right after the signature?  Also, it would be nice to explicit the why of this recommendation (e.g. “due to the number of arguments, it is recommended to always use keyword arguments for this function”).
History
Date User Action Args
2011-11-14 16:58:11eric.araujosetrecipients: + eric.araujo, terry.reedy, roysmith, bethard, flox, santoso.wijaya, docs@python, petri.lehtinen
2011-11-14 16:58:11eric.araujosetmessageid: <1321289891.78.0.333370554336.issue13249@psf.upfronthosting.co.za>
2011-11-14 16:58:11eric.araujolinkissue13249 messages
2011-11-14 16:58:10eric.araujocreate