Raymond Hettinger raymond.hettinger at gmail.com
Fri Mar 16 17:09:55 CET 2012

• Previous message: [Python-Dev] cpython: PEP 417: Adding unittest.mock
• Next message: [Python-Dev] cpython: PEP 417: Adding unittest.mock
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

---

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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-dev/attachments/20120316/d747dd18/attachment.html>

---

• Previous message: [Python-Dev] cpython: PEP 417: Adding unittest.mock
• Next message: [Python-Dev] cpython: PEP 417: Adding unittest.mock
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

---

More information about the Python-Dev mailing list