[docs] [issue13386] Document documentation conventions for optional args

Éric Araujo report at bugs.python.org
Mon Nov 14 14:46:02 CET 2011


Éric Araujo <merwok at netwok.org> added the comment:

> Do we need an introductory page aimed to the readers that explains
> the conventions used in the doc?

Explaining notational conventions at the start of a technical reference sounds like a best practice to me.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue13386>
_______________________________________


More information about the docs mailing list