Marco Buttu added the comment:

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

----------

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

Reply via email to