[issue12828] xml.dom.minicompat is not documented
New submission from Sandro Tosi <sandro.tosi@gmail.com>: There's no documentation for xml.dom.minicompat - it's a public module and it should have (even a brief) doc. ---------- assignee: docs@python components: Documentation messages: 142845 nosy: docs@python, sandro.tosi priority: normal severity: normal status: open title: xml.dom.minicompat is not documented versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12828> _______________________________________
Éric Araujo <merwok@netwok.org> added the comment: I’m not sure at all this module should be treated as anything but an internal detail. The docstring of xml.dom only mentions two submodules. ---------- components: +XML nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12828> _______________________________________
Sandro Tosi <sandro.tosi@gmail.com> added the comment:
Éric Araujo <merwok@netwok.org> added the comment:
I’m not sure at all this module should be treated as anything but an internal detail. The docstring of xml.dom only mentions two submodules.
If it's an implementation detail, then probably a small reference in the module docstring could be helpful. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12828> _______________________________________
Roundup Robot added the comment: New changeset 3710514aa92a by Andrew Kuchling in branch '3.3': Closes #12828: add docstring text noting this is an internal-only module http://hg.python.org/cpython/rev/3710514aa92a ---------- nosy: +python-dev resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12828> _______________________________________
participants (3)
-
Roundup Robot -
Sandro Tosi
-
Éric Araujo