This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author ncoghlan
Recipients Ramchandra Apte, amak, eli.bendersky, eric.araujo, ezio.melotti, georg.brandl, giampaolo.rodola, hynek, ncoghlan, pmoody, python-dev, sandro.tosi, serhiy.storchaka, terry.reedy, tshepang
Date 2012-07-31.08:29:57
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1343723398.04.0.626004638379.issue14814@psf.upfronthosting.co.za>
In-reply-to
Content
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).
History
Date User Action Args
2012-07-31 08:29:58ncoghlansetrecipients: + ncoghlan, georg.brandl, terry.reedy, giampaolo.rodola, amak, ezio.melotti, eric.araujo, pmoody, eli.bendersky, sandro.tosi, tshepang, python-dev, Ramchandra Apte, hynek, serhiy.storchaka
2012-07-31 08:29:58ncoghlansetmessageid: <1343723398.04.0.626004638379.issue14814@psf.upfronthosting.co.za>
2012-07-31 08:29:57ncoghlanlinkissue14814 messages
2012-07-31 08:29:57ncoghlancreate