Skip to content

[3.15] gh-156839: Fix inaccuracies in the xml.dom.pulldom documentation (GH-156840) - #156845

Open
miss-islington wants to merge 1 commit into
python:3.15from
miss-islington:backport-c265821-3.15
Open

[3.15] gh-156839: Fix inaccuracies in the xml.dom.pulldom documentation (GH-156840)#156845
miss-islington wants to merge 1 commit into
python:3.15from
miss-islington:backport-c265821-3.15

Conversation

@miss-islington

@miss-islington miss-islington commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Corrected:

  • the node types for the PROCESSING_INSTRUCTION and COMMENT events;
  • the return value of getEvent() at the end of the document;
  • the type of the argument of parseString();
  • references to the xml.dom interfaces, written as xml.dom.minidom.

Documented:

  • the event constants, which were referenced but never described;
  • PullDOM, SAX2DOM and the documentFactory argument;
  • the arguments of DOMEventStream, its reset() and clear() methods.

Added docstrings to the module, the classes and their public methods, and
removed the commented out paragraph about pulldom in the xml.dom
documentation, which was never rendered and refers to a site which no longer
exists.
(cherry picked from commit c265821)

Co-authored-by: Serhiy Storchaka storchaka@gmail.com

pythonGH-156840)

Corrected:

* the node types for the PROCESSING_INSTRUCTION and COMMENT events;
* the return value of getEvent() at the end of the document;
* the type of the argument of parseString();
* references to the xml.dom interfaces, written as xml.dom.minidom.

Documented:

* the event constants, which were referenced but never described;
* PullDOM, SAX2DOM and the documentFactory argument;
* the arguments of DOMEventStream, its reset() and clear() methods.

Added docstrings to the module, the classes and their public methods, and
removed the commented out paragraph about pulldom in the xml.dom
documentation, which was never rendered and refers to a site which no longer
exists.
(cherry picked from commit c265821)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
@read-the-docs-community

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants