Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jang-hs wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −5
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8c5e09
gh-151943: Fix Sphinx reference warnings in `Doc/library/xmlrpc.clien…
jang-hs Sep 30, 2026
9a4bce1
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
jang-hs Sep 30, 2026
f942c7e
Keep Server alias as a sentence in ServerProxy description
jang-hs Sep 30, 2026
8adc80c
Merge branch 'main' into fix/issue-151943-xmlrpc-client-refs
jang-hs Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions Doc/library/xmlrpc.client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ between conformable Python objects and XML on the wire.
remote XML-RPC server. The required first argument is a URI (Uniform Resource
Indicator), and will normally be the URL of the server. The optional second
argument is a transport factory instance; by default it is an internal
:class:`SafeTransport` instance for https: URLs and an internal HTTP
:class:`Transport` instance otherwise. The optional third argument is an
:class:`!SafeTransport` instance for https: URLs and an internal HTTP
:class:`!Transport` instance otherwise. The optional third argument is an
encoding, by default UTF-8. The optional fourth argument is a debugging flag.

The following parameters govern the use of the returned proxy instance.
Expand Down Expand Up @@ -142,7 +142,7 @@ between conformable Python objects and XML on the wire.
via XML-RPC, use :class:`bytes` or :class:`bytearray` classes or the
:class:`Binary` wrapper class described below.

:class:`Server` is retained as an alias for :class:`ServerProxy` for backwards
:class:`!Server` is retained as an alias for :class:`ServerProxy` for backwards
compatibility. New code should use :class:`ServerProxy`.

.. versionchanged:: 3.5
Expand All @@ -156,6 +156,11 @@ between conformable Python objects and XML on the wire.
See https://ws.apache.org/xmlrpc/types.html for a description.


.. exception:: Error

Base class of the :exc:`Fault` and :exc:`ProtocolError` exceptions.


.. seealso::

`XML-RPC HOWTO <https://tldp.org/HOWTO/XML-RPC-HOWTO/index.html>`_
Expand All @@ -181,7 +186,7 @@ by returning data in a conformant type or by raising a :class:`Fault` or
:class:`ProtocolError` exception indicating an error.

Servers that support the XML introspection API support some common methods
grouped under the reserved :attr:`~ServerProxy.system` attribute:
grouped under the reserved :attr:`!system` attribute:


.. method:: ServerProxy.system.listMethods()
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,4 @@ Doc/library/wsgiref.rst
Doc/library/xml.dom.minidom.rst
Doc/library/xml.sax.reader.rst
Doc/library/xml.sax.rst
Doc/library/xmlrpc.client.rst
Doc/library/xmlrpc.server.rst
Loading