[issue13743] xml.dom.minidom.Document class is not documented

[Stefan Behnel]

Stefan Behnel  added the comment:

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

--
versions:  -Python 2.7, Python 3.2, Python 3.3, Python 3.5, Python 3.6, Python 
3.7, Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Stefan Behnel]

Stefan Behnel  added the comment:


New changeset 63e5b59c06fc99f95d274e7f181296e094cc3ee7 by Alex Itkes in branch 
'master':
bpo-13743: Add some documentation strings to xml.dom.minidom (GH-16355)
https://github.com/python/cpython/commit/63e5b59c06fc99f95d274e7f181296e094cc3ee7


--
nosy: +scoder

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Alex Itkes]

Change by Alex Itkes :


--
pull_requests: +15939
pull_request: https://github.com/python/cpython/pull/16355

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Alex Itkes]

Change by Alex Itkes :


--
pull_requests:  -15938

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Alex Itkes]

Alex Itkes  added the comment:

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.

--
keywords: +patch
message_count: 3.0 -> 4.0
nosy: +alexitkes
nosy_count: 4.0 -> 5.0
pull_requests: +15938
stage: needs patch -> patch review
versions: +Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9
pull_request: https://github.com/python/cpython/pull/16335

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Henry Harutyunyan]

Change by Henry Harutyunyan :


--
nosy: +hharutyunyan

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Mark Lawrence]

Changes by Mark Lawrence :


--
nosy:  -BreamoreBoy

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Martin Panter]

Martin Panter added the comment:

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.

--
components: +XML
nosy: +martin.panter

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Mark Lawrence]

Mark Lawrence added the comment:

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

--
nosy: +BreamoreBoy

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue13743] xml.dom.minidom.Document class is not documented

[Sandro Tosi]

New submission from Sandro Tosi :

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 :)

--
assignee: docs@python
components: Documentation
messages: 150935
nosy: docs@python, sandro.tosi
priority: normal
severity: normal
stage: needs patch
status: open
title: xml.dom.minidom.Document class is not documented
versions: Python 2.7, Python 3.2, Python 3.3

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com