Repository navigation
gh-151943: Fix Sphinx reference warnings in Doc/library/xmlrpc.client.rst - #158484
Open
jang-hs wants to merge 6 commits into
Open
jang-hs wants to merge 6 commits into
jang-hs wants to merge 6 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
….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.
jang-hs
requested review from
AA-Turner,
StanFromIreland and
hugovk
as code owners
September 30, 2026 07:20
Copy link
Copy Markdown
Documentation build overview114 files changed · ± 114 modified ± Modified |
Sorry, something went wrong.
Comment thread
Doc/library/xmlrpc.client.rst
Outdated
Comment on lines
+156
to
+159
| .. class:: Server | ||
|
|
||
| Retained as an alias for :class:`ServerProxy` for backwards compatibility. | ||
| New code should use :class:`ServerProxy`. |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Let's just leave this as a sentence in the description of ServerProxy, as it's only an old alias.
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment.
Done - moved it back into the ServerProxy description (with ! since there's no longer a target).
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
2 participants
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.
Error, the base class of Fault and ProtocolError, and Server, the backwards-compatible alias of ServerProxy, both exist at runtime but had no entries on the page, so the references to them in the ServerProxy description did not resolve. This adds an exception entry for Error and a class entry for Server right after ServerProxy, and moves the existing alias note out of the ServerProxy description into the new Server entry rather than repeating it.
Transport and SafeTransport are different: the same sentence 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 with ! for now. 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 too.
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.