Issue 7303: pkgutil lacks documentation for useful functions (original) (raw)

Created on 2009-11-10 22:12 by englabenny, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
pkgutil-docs-py3k-branch.patch glimberg,2010-07-25 05:00 pkgutil reST documentation
Messages (7)
msg95132 - (view) Author: (englabenny) Date: 2009-11-10 22:12
The module pkgutil has no documentation of functions added after its introduction, in the official python documentation collection. http://docs.python.org/dev/py3k/library/pkgutil.html The module is well documented with docstrings. I assume the module's exposed functions, some very useful, are open for public use, for example pkgutil.iter_modules and .walk_packages. Is all that is required copying the docstrings into the documentation? If someone believes only Python insight and knowledge of reST sytax is enough to make some passable documentation from the existing docstrings, I could submit a patch for that.
msg109868 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2010-07-10 13:47
Ulrik could you please submit a patch?
msg110612 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-07-17 23:02
Thanks for your help proposal Ulrik. If I understand the documentation correctly, docstrings should contain enough usage information but not too much. In pkgutil, some examples and long explanations could be removed after you move them to the reST doc. Make sure to work from a checkout of 3.2 (branch named py3k) to have the latest updates. This page contains some tips about patches: http://www.python.org/dev/patches/ You can ask any questions here or on the docs@python.org mailing list. Thanks again.
msg110614 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-07-17 23:04
Other useful advice: http://docs.pythonsprints.com/core_development/beginners#building-the-documentation http://docs.python.org/documenting/
msg110615 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-07-17 23:05
Wrong link, sorry everyone for the noise: http://docs.pythonsprints.com/core_development/beginners.html#building-the-documentation
msg111520 - (view) Author: Grant Limberg (glimberg) Date: 2010-07-25 05:00
I've taken the liberty of creating a patch for this issue. I've taken the docstrings fromt he pkgutil module and conveted them to reST. Please let me know if there are any changes necessary.
msg118798 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-10-15 16:36
Fixed markup a bit and committed in r85538. Thanks!
History
Date User Action Args
2022-04-11 14:56:54 admin set github: 51552
2010-10-15 16:36:06 georg.brandl set status: open -> closedmessages: +
2010-07-25 08:27:01 BreamoreBoy set stage: needs patch -> patch review
2010-07-25 05:00:34 glimberg set files: + pkgutil-docs-py3k-branch.patchnosy: + glimbergmessages: + keywords: + patch
2010-07-17 23:05:06 eric.araujo set messages: +
2010-07-17 23:04:14 eric.araujo set messages: +
2010-07-17 23:02:44 eric.araujo set messages: +
2010-07-10 18:07:56 eric.araujo set keywords: + easynosy: + eric.araujoresolution: acceptedstage: needs patch
2010-07-10 13:47:20 BreamoreBoy set assignee: georg.brandl -> docs@pythonmessages: + nosy: + docs@python, BreamoreBoy
2009-11-11 02:35:18 benjamin.peterson set nosy: + pje
2009-11-10 22:12:31 englabenny create