[issue15583] Provide examples in Python doc for usage of various modules

Ezio Melotti report at bugs.python.org
Wed Aug 8 06:34:28 CEST 2012


Ezio Melotti added the comment:

> If you look at ElementTree XMl module or take any other
> standard module, examples which are provided are very limited

We already try to provide examples where/when appropriate, and several modules have examples showing the basic usage.  Often, documenting all the methods will only make the documentation less readable, so only the most important/common functions/methods have examples.  Some modules also have separate howtos that contain extensive examples.

If you think some specific module (like ElementTree) needs more examples, feel free to open specific reports.

----------
nosy: +eli.bendersky, ezio.melotti

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15583>
_______________________________________


More information about the Python-bugs-list mailing list