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.

classification
Title: pkgutil lacks documentation for useful functions
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.2
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: docs@python Nosy List: BreamoreBoy, docs@python, englabenny, eric.araujo, georg.brandl, glimberg, pje
Priority: normal Keywords: easy, patch

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:54adminsetgithub: 51552
2010-10-15 16:36:06georg.brandlsetstatus: open -> closed

messages: + msg118798
2010-07-25 08:27:01BreamoreBoysetstage: needs patch -> patch review
2010-07-25 05:00:34glimbergsetfiles: + pkgutil-docs-py3k-branch.patch

nosy: + glimberg
messages: + msg111520

keywords: + patch
2010-07-17 23:05:06eric.araujosetmessages: + msg110615
2010-07-17 23:04:14eric.araujosetmessages: + msg110614
2010-07-17 23:02:44eric.araujosetmessages: + msg110612
2010-07-10 18:07:56eric.araujosetkeywords: + easy
nosy: + eric.araujo

resolution: accepted
stage: needs patch
2010-07-10 13:47:20BreamoreBoysetassignee: georg.brandl -> docs@python

messages: + msg109868
nosy: + docs@python, BreamoreBoy
2009-11-11 02:35:18benjamin.petersonsetnosy: + pje
2009-11-10 22:12:31englabennycreate