xml.dom.minicompat is not documented

[sandrotosi]

BPO	12828
Nosy	@merwok, @sandrotosi

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-11-12.15:25:23.043>
created_at = <Date 2011-08-23.17:46:56.903>
labels = ['expert-XML', 'docs']
title = 'xml.dom.minicompat is not documented'
updated_at = <Date 2013-11-12.15:25:23.041>
user = 'https://github.com/sandrotosi'

bugs.python.org fields:

activity = <Date 2013-11-12.15:25:23.041>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-11-12.15:25:23.043>
closer = 'python-dev'
components = ['Documentation', 'XML']
creation = <Date 2011-08-23.17:46:56.903>
creator = 'sandro.tosi'
dependencies = []
files = []
hgrepos = []
issue_num = 12828
keywords = []
message_count = 4.0
messages = ['142845', '142848', '142850', '202694']
nosy_count = 4.0
nosy_names = ['eric.araujo', 'sandro.tosi', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue12828'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']

[sandrotosi]

There's no documentation for xml.dom.minicompat - it's a public module and it should have (even a brief) doc.

[merwok]

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.

[sandrotosi]

É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-dev]

New changeset 3710514aa92a by Andrew Kuchling in branch '3.3':
Closes bpo-12828: add docstring text noting this is an internal-only module
http://hg.python.org/cpython/rev/3710514aa92a