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: xml.dom.minicompat is not documented
Type: Stage: resolved
Components: Documentation, XML Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, python-dev, sandro.tosi
Priority: normal Keywords:

Created on 2011-08-23 17:46 by sandro.tosi, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg142845 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-08-23 17:46
There's no documentation for xml.dom.minicompat - it's a public module and it should have (even a brief) doc.
msg142848 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-08-23 17:54
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.
msg142850 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-08-23 17:57
> É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.
msg202694 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-11-12 15:25
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
History
Date User Action Args
2022-04-11 14:57:21adminsetgithub: 57037
2013-11-12 15:25:23python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg202694

resolution: fixed
stage: resolved
2011-08-23 17:57:08sandro.tosisetmessages: + msg142850
2011-08-23 17:54:27eric.araujosetnosy: + eric.araujo
messages: + msg142848
components: + XML
2011-08-23 17:46:56sandro.tosicreate