Nick Coghlan added the comment:

No, the HOWTO should be separate. Having them in the same document makes for 
something that is worse as both a tutorial and as an API reference (just look 
at argparse).

Yes, that means there are three places to update (code, reference, tutorial). 
There are three places to update regardless - the only question is whether two 
of those places are jammed awkwardly into the same file. Handling this will 
hopefully become more natural as the howto/tutorial section of the docs grows 
larger.

The main problem with the ipadddress docs at the moment is extracting the 
docstrings for the methods and including them in the reference docs in a sane 
way (i.e. without excessive duplication of material, as Terry and I discussed 
above).

----------

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

Reply via email to