GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

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

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

Uh oh!

There was an error while loading. Please reload this page.

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.

  • Issue: Fix all Sphinx reference warnings in Doc/library/{xml*,pyexpat}.rst #151943

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@jang-hs
pythongh-151943: Fix Sphinx reference warnings in `Doc/library/xmlrpc…
e8c5e09
….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
jang-hs requested review from AA-Turner, StanFromIreland and hugovk as code owners September 30, 2026 07:20
@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 30, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Sep 30, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Sep 30, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Sep 30, 2026
Fix all Sphinx reference warnings in Doc/library/{xml*,pyexpat}.rst #151943
Open
@read-the-docs-community

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

Uh oh!

There was an error while loading. Please reload this page.

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

  • c-api/pyexpat.html

± Modified

  • glossary.html
  • index.html
  • license.html
  • py-modindex.html
  • _static/tachyon-example-heatmap.html
  • builtins/functions.html
  • builtins/stdtypes.html
  • c-api/bytes.html
  • c-api/capsule.html
  • c-api/code.html
  • and 160 more...
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
9a4bce1
StanFromIreland
StanFromIreland reviewed Sep 30, 2026
View reviewed changes
Comment thread Doc/library/xmlrpc.client.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

jang-hs added 4 commits October 1, 2026 08:59
@jang-hs
Keep Server alias as a sentence in ServerProxy description
f942c7e
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
8adc80c
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
879655f
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
9793f37
@jang-hs
jang-hs requested a review from StanFromIreland October 20, 2026 05:00
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
12d7107
@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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

StanFromIreland
StanFromIreland reviewed Oct 27, 2026
View reviewed changes
Comment thread Doc/library/xmlrpc.client.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread Doc/library/xmlrpc.client.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@jang-hs
Move Error to its own section and document ResponseError
bf16d16
@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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

jang-hs added 2 commits October 28, 2026 11:41
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
e006838
@jang-hs
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
112b6ac
@jang-hs

jang-hs commented Nov 9, 2026

Copy link
Copy Markdown
Contributor Author

@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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments
@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@hugovk 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

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.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@jang-hs @StanFromIreland
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.