Skip to content

gh-155631: Document the CharacterData interface and other DOM members - #155632

Open
serhiy-storchaka wants to merge 1 commit into
python:mainfrom
serhiy-storchaka:doc-characterdata
Open

gh-155631: Document the CharacterData interface and other DOM members#155632
serhiy-storchaka wants to merge 1 commit into
python:mainfrom
serhiy-storchaka:doc-characterdata

Conversation

@serhiy-storchaka

Copy link
Copy Markdown
Member

The CharacterData interface was not mentioned in the documentation at all, although Text, Comment and CDATASection inherit from it, so its length attribute and mutation methods were not documented.

Other implemented members which were omitted are documented too: Node.ownerDocument, Node.isSupported(), Node.getUserData(), Node.setUserData(), Document.doctype, Document.implementation, Document.documentURI, Document.strictErrorChecking, Document.createDocumentFragment(), Document.createCDATASection(), Document.importNode(), Document.renameNode(), Element.setIdAttribute(), Element.setIdAttributeNS(), Element.setIdAttributeNode(), Attr.isId, Attr.ownerElement, Text.wholeText, Text.splitText() and Text.replaceWholeText().

…embers

CharacterData was not mentioned at all, although Text, Comment and
CDATASection inherit from it.  Also document members which are
implemented, but were omitted: Node.ownerDocument, Node.isSupported(),
Node.getUserData(), Node.setUserData(), Document.doctype,
Document.implementation, Document.documentURI,
Document.strictErrorChecking, Document.createDocumentFragment(),
Document.createCDATASection(), Document.importNode(),
Document.renameNode(), Element.setIdAttribute(),
Element.setIdAttributeNS(), Element.setIdAttributeNode(), Attr.isId,
Attr.ownerElement, Text.wholeText, Text.splitText() and
Text.replaceWholeText().
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Aug 12, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Aug 12, 2026
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 12, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34035139 | 📁 Comparing dcbb0fb against main (b11e749)

  🔍 Preview build  

2 files changed
± library/markup.html
± library/xml.dom.html

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

Labels

awaiting core review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant