FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-151943: Fix incorrect interface names in xml.sax.rst by manoj-marimuthu · Pull Request #151961 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-151943: Fix incorrect interface names in xml.sax.rst - #151961

Open
manoj-marimuthu wants to merge 6 commits into
python:mainfrom
manoj-marimuthu:fix-sphinx-warnings-in-doc-lib-xml
ConversationCommits (6)ChecksFiles changed
Open

gh-151943: Fix incorrect interface names in xml.sax.rst#151961
manoj-marimuthu wants to merge 6 commits into
python:mainfrom
manoj-marimuthu:fix-sphinx-warnings-in-doc-lib-xml

Conversation

manoj-marimuthu commented Jun 23, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

The following PR addresses aims to remove the warnings from sphinx that are raised for xml.sax.rst. (total 3 warnings)

Warnings removed:

WARNING: py:class reference target not found: xml.sax.xmlreader.Attributes [ref.class]
WARNING: py:class reference target not found: xml.sax.xmlreader.AttributesNS [ref.class]
  • The above warnings were removed by replacing xml.sax.xmlreader.Attributes with xml.sax.xmlreader.AttributesImpl and
    xml.sax.xmlreader.AttributesNS with xml.sax.xmlreader.AttributesNSImpl.

Verification :

Warnings remaining:

WARNING: py:func reference target not found: create_parser [ref.func]
  • The above warning is due to the absence of documentation for create_parser function. We can either add documentation for it or remove the documentation's reference to create_parser. Waiting for suggestions.

bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 23, 2026
github-project-automation Bot moved this to Todo in Docs PRs Jun 23, 2026
bedevere-app Bot mentioned this pull request Jun 23, 2026
Open

read-the-docs-community Bot commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #34185026 | 📁 Comparing 9079d6e against main (3f09a17)

  🔍 Preview build  

195 files changed · + 3 added · ± 191 modified · - 1 deleted

+ Added

± Modified

- Deleted

harjothkhara mentioned this pull request Jul 1, 2026
Closed
StanFromIreland reviewed Jul 2, 2026
View reviewed changes

StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

As for create_parser, please add a reference (.. _sax-parser-modules:) to the note at the top of the xml.sax.reader documentation. We can then expand that note.

Comment thread Doc/library/xml.sax.rst Outdated
and :class:`~xml.sax.xmlreader.XMLReader` interfaces are defined in the
module :mod:`xml.sax.xmlreader`. The handler interfaces are defined in
:mod:`xml.sax.handler`. For convenience,
:class:`~xml.sax.xmlreader.AttributesImpl`,

StanFromIreland Jul 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

These should instead link to :ref:`Attributes <attributes-objects>` and :ref:`AttributesNS <attributes-ns-objects>`.

StanFromIreland reviewed Jul 2, 2026
View reviewed changes

StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

You didn't actually fix the issue with create_parser? Please change it to a reference as I noted before. You should then be able to remove the file from .nitignore.

Comment thread Doc/library/xml.sax.rst Outdated
:class:`~xml.sax.xmlreader.InputSource` (which is often
instantiated directly) and the handler classes are also available from
:mod:`!xml.sax`. These interfaces are described below.
:ref:`Attributes <attributes-objects>`,:ref:`AttributesNS <attributes-ns-objects>`,

StanFromIreland Jul 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Missing space here.

Comment thread Doc/library/xml.sax.rst Outdated
:mod:`!xml.sax`. These interfaces are described below.
:ref:`Attributes <attributes-objects>`,:ref:`AttributesNS <attributes-ns-objects>`,
and :class:`~xml.sax.xmlreader.XMLReader` interfaces are defined in the module
:mod:`xml.sax.xmlreader`. The handler interfaces are defined in

StanFromIreland Jul 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Please keep double spacing for consistency.

manoj-marimuthu commented Jul 3, 2026

Copy link
Copy Markdown
Contributor Author

@StanFromIreland I believe I have added the reference now, I am new to sphinx.

manoj-marimuthu commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

@StanFromIreland A gentle reminder.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
hugovk Awaiting requested review from hugovk hugovk is a code owner
StanFromIreland Awaiting requested review from StanFromIreland StanFromIreland is a code owner

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL