[issue15583] Provide examples in Python doc for usage of various modules
New submission from Sarbjit singh: For beginners who are learning Python, it would be very helpful if Python doc could provide examples on usage of various methods/attributes of different modules. For eg: If you look at ElementTree XMl module or take any other standard module, examples which are provided are very limited making it hard for new users to learn those modules and have to search internet for its usage. Providing examples on usage of module attributes/methods will help users to quickly understand it. ---------- assignee: docs@python components: Documentation messages: 167657 nosy: Sarbjit.singh, docs@python priority: normal severity: normal status: open title: Provide examples in Python doc for usage of various modules type: enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15583> _______________________________________
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@bugs.python.org> <http://bugs.python.org/issue15583> _______________________________________
R. David Murray added the comment: I'm closing this with no specific resolution because the real resolution is "this issue is too general" :) As Ezio said, specific suggestions are welcome, but should be in separate issues limited to the module/example proposed. ---------- nosy: +r.david.murray stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15583> _______________________________________
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@bugs.python.org> <http://bugs.python.org/issue15583> _______________________________________
R. David Murray added the comment: I'm closing this with no specific resolution because the real resolution is "this issue is too general" :) As Ezio said, specific suggestions are welcome, but should be in separate issues limited to the module/example proposed. ---------- nosy: +r.david.murray stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15583> _______________________________________
participants (3)
-
Ezio Melotti -
R. David Murray
-
Sarbjit singh