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 marco.buttu
Recipients JDLH, docs@python, marco.buttu, r.david.murray
Date 2017-02-04.16:16:56
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1486225016.6.0.169682481504.issue29428@psf.upfronthosting.co.za>
In-reply-to
Content
IMO if you would like to apply big changes to the current doc, as you wrote before, maybe is worth considering to propose a separate howto, instead of wide changes to the current page. I am suggesting this to you, because looking at the other modules of the standard library, I see they just explain the API, extending with examples when needed. When is worth adding extra documentation, in a different style, I see the usual solution is to extend with an howto. Look at the argparse module and related howto, for instance:

https://docs.python.org/3/library/argparse.html
https://docs.python.org/3/howto/argparse.html

I also think an howto in this case is appropriate, because there is more to say than only the API. If you want to follow the howto way, I would like to contribute. In any case, I am disposed to review your patch
History
Date User Action Args
2017-02-04 16:16:56marco.buttusetrecipients: + marco.buttu, r.david.murray, docs@python, JDLH
2017-02-04 16:16:56marco.buttusetmessageid: <1486225016.6.0.169682481504.issue29428@psf.upfronthosting.co.za>
2017-02-04 16:16:56marco.buttulinkissue29428 messages
2017-02-04 16:16:56marco.buttucreate