xml.dom.minidom.Document class is not documented

[sandrotosi]

BPO	13743
Nosy	@scoder, @sandrotosi, @vadmium, @henryh9n, @alexitkes
PRs	bpo-13743: Add some documentation strings to xml.dom.minidom #16355

^{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 = None
created_at = <Date 2012-01-09.13:06:12.457>
labels = ['expert-XML', '3.9', 'docs']
title = 'xml.dom.minidom.Document class is not documented'
updated_at = <Date 2020-04-12.14:23:13.182>
user = 'https://github.com/sandrotosi'

bugs.python.org fields:

activity = <Date 2020-04-12.14:23:13.182>
actor = 'scoder'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'XML']
creation = <Date 2012-01-09.13:06:12.457>
creator = 'sandro.tosi'
dependencies = []
files = []
hgrepos = []
issue_num = 13743
keywords = ['patch']
message_count = 6.0
messages = ['150935', '221975', '258341', '353112', '366250', '366251']
nosy_count = 6.0
nosy_names = ['scoder', 'sandro.tosi', 'docs@python', 'martin.panter', 'hharutyunyan', 'alexitkes']
pr_nums = ['16355']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue13743'
versions = ['Python 3.9']

[sandrotosi]

Hello, following up http://mail.python.org/pipermail/docs/2012-January/007026.html I noticed the whole Document class (and relative methods) is not documented.

Maybe it is a choice to not document it, or maybe it's just a missing doc, dunno, the's why I'm opening this :)

[BreamoreBoy]

This https://docs.python.org/3/library/xml.dom.minidom.html#module-xml.dom.minidom currently states under section 20.7.1 "The definition of the DOM API for Python is given as part of the xml.dom module documentation. This section lists the differences between the API and xml.dom.minidom.". The Document object is described here https://docs.python.org/3/library/xml.dom.html#document-objects

[vadmium]

In xml.dom, the documentation suggests that there are classes called Document and others, and I was surprised to find that they don’t exist. Apparently they are more like pseudo-code names of abstract interfaces instead. However in xml.dom.minidom there is a real Python class called Document. The documentation should be clearer about this.

I don’t think we need to duplicate the descriptions already given in xml.dom. But it would be good to explicitly say what the public minidom classes are, and point out (or link) what APIs they support.

[alexitkes]

Although the Document, Element, etc. classes are well documented in online docs, it is sometimes easier to use pydoc to view the documentation. I think documentation strings should be included to these classes. Just created a PR adding some docstrings.

[scoder]

New changeset 63e5b59 by Alex Itkes in branch 'master':
bpo-13743: Add some documentation strings to xml.dom.minidom (GH-16355)
63e5b59

[scoder]

A first PR was applied, but I'll leave this ticket open since it changes nothing for the "Document" class. :)