Skip to content

gh-151943: Fix Sphinx reference warnings in Doc/library/xmlrpc.client.rst - #158484

Open
jang-hs wants to merge 10 commits into
python:mainfrom
jang-hs:fix/issue-151943-xmlrpc-client-refs
Open

jang-hs wants to merge 10 commits into
python:mainfrom
jang-hs:fix/issue-151943-xmlrpc-client-refs

Conversation

@jang-hs

@jang-hs jang-hs commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Error, the base class of Fault, ProtocolError and ResponseError, and ResponseError itself both exist at runtime but had no entries on the page, so references to them did not resolve. This adds a new "Error Objects" section just before "Fault Objects" with exception entries for both.

Server is only an old alias of ServerProxy, so it stays a sentence in the ServerProxy description and its link is suppressed with !. Transport and SafeTransport are different: the same description calls them internal, and the XXX note at the top of the file already lists Transport among the things that are not documented yet. Documenting them properly is a larger change than a reference fix, so those two links are suppressed too. The introspection paragraph linked :attr:`~ServerProxy.system` , which has no entry of its own; the methods under it are documented as ServerProxy.system.listMethods() and so on, so that link is suppressed as well.

A clean nit-picky build shows no warnings left for the file, and Doc/tools/check-warnings.py --fail-if-regression --fail-if-improved --fail-if-new-news-nit passes with the entry removed from .nitignore.

I had help from an LLM to find the warnings and draft the change and this description. I reviewed the diff and the build results before opening.

….client.rst`

Error, the base class of Fault and ProtocolError, and the Server alias
of ServerProxy are public but had no entries, so references to them did
not resolve. Document them next to ServerProxy; the alias note moves out
of the ServerProxy description into the new Server entry. Transport and
SafeTransport are described as internal and are left undocumented, as
the note at the top of the file says, so those links are suppressed, as
is the link to the ServerProxy.system attribute, which has no entry of
its own; the methods under it are documented as
ServerProxy.system.listMethods() and so on.

Doc/library/xmlrpc.client.rst now builds clean in nit-picky mode and
comes out of Doc/tools/.nitignore.
@read-the-docs-community

read-the-docs-community Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35461079 | 📁 Comparing 112b6ac against main (b7b4f3e)

  🔍 Preview build  

171 files changed · + 1 added · ± 170 modified

+ Added

± Modified

Comment thread Doc/library/xmlrpc.client.rst Outdated
@jang-hs

jang-hs commented Oct 27, 2026

Copy link
Copy Markdown
Contributor Author

@StanFromIreland I've addressed your suggestion: the old alias is now just a sentence in the ServerProxy description (using ! since there's no target anymore). Could you take another look when you have a moment?

Comment thread Doc/library/xmlrpc.client.rst Outdated
Comment thread Doc/library/xmlrpc.client.rst Outdated
@jang-hs

jang-hs commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

@StanFromIreland I've addressed your comments: Error now has its own "Error Objects" section next to Fault, and ResponseError is documented there as well. Could you take another look when you have a moment?

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

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants