classification
Title: xml.dom.minidom.Document class is not documented
Type: Stage: patch review
Components: Documentation, XML Versions: Python 3.9, Python 3.8, Python 3.7, Python 3.6, Python 3.2, Python 3.3, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: alexitkes, docs@python, hharutyunyan, martin.panter, sandro.tosi
Priority: normal Keywords: patch

Created on 2012-01-09 13:06 by sandro.tosi, last changed 2019-09-24 19:10 by alexitkes.

Pull Requests
URL Status Linked Edit
PR 16355 open alexitkes, 2019-09-24 19:10
Messages (4)
msg150935 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2012-01-09 13:06
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 :)
msg221975 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2014-06-30 18:28
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
msg258341 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-01-16 00:13
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.
msg353112 - (view) Author: Alex Itkes (alexitkes) * Date: 2019-09-24 19:06
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.
History
Date User Action Args
2019-09-24 19:10:14alexitkessetpull_requests: + pull_request15939
2019-09-24 19:09:43alexitkessetpull_requests: - pull_request15938
2019-09-24 19:06:17alexitkessetversions: + Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9
keywords: + patch
nosy: + alexitkes

messages: + msg353112
stage: needs patch -> patch review
pull_requests: + pull_request15938
2019-09-19 10:45:07hharutyunyansetnosy: + hharutyunyan
2016-01-16 09:42:26BreamoreBoysetnosy: - BreamoreBoy
2016-01-16 00:13:57martin.pantersetnosy: + martin.panter
messages: + msg258341
components: + XML
2014-06-30 18:28:15BreamoreBoysetnosy: + BreamoreBoy
messages: + msg221975
2012-01-09 13:06:12sandro.tosicreate