Éric Araujo <mer...@netwok.org> added the comment:

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”).

----------

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue13249>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to