(original) (raw)
On Mar 16, 2012, at 4:54 AM, Nick Coghlan wrote:
Don't forgot you also have the option of splitting out a separate
HOWTO tutorial section, leaving the main docs as a pure API reference.
(I personally find that style easier to use than the ones which try to
address both needs in the main module docs).
+1
The commingling of extensive examples with regular docs has
made it difficult to lookup functionality in argparse for example.
In contrast, the logging module's howtos were split-out to good effect.
Raymond