[Python-Dev] cpython: PEP 417: Adding unittest.mock

"Martin v. Löwis" martin at v.loewis.de
Mon Mar 19 02:19:20 CET 2012


> The commingling of extensive examples with regular docs has
> made it difficult to lookup functionality in argparse for example.

I have now come to think that this should be considered a subordinate
use case. The primary use case of the documentation should be copy-paste
style examples. At least, that's the feedback I always get for the
Python documentation (typically contrasting it with the PHP
documentation, where the specification-style portion is typically
ignored by readers, which then move on to the user-contributed
examples).

Regards,
Martin


More information about the Python-Dev mailing list