GeezerVison is showing github.com — gh-151943: Fix Sphinx reference warnings in `Doc/library/xmlrpc.client.rst` by jang-hs · Pull Request #158484 · python/cpython
Conversation
jang-hs
commented
Sep 30, 2026
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
….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.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
|
@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?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
|
@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?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
@StanFromIreland Gentle ping. Both of your last comments are addressed: Error and ResponseError now live in a new "Error Objects" section next to Fault. Could you take another look when you have a moment?
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|