Skip to content

Commit e8c5e09

Browse files
committed
gh-151943: Fix Sphinx reference warnings in Doc/library/xmlrpc.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.
1 parent b7b4f3e commit e8c5e09

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

‎Doc/library/xmlrpc.client.rst‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ between conformable Python objects and XML on the wire.
3939
remote XML-RPC server. The required first argument is a URI (Uniform Resource
4040
Indicator), and will normally be the URL of the server. The optional second
4141
argument is a transport factory instance; by default it is an internal
42-
:class:`SafeTransport` instance for https: URLs and an internal HTTP
43-
:class:`Transport` instance otherwise. The optional third argument is an
42+
:class:`!SafeTransport` instance for https: URLs and an internal HTTP
43+
:class:`!Transport` instance otherwise. The optional third argument is an
4444
encoding, by default UTF-8. The optional fourth argument is a debugging flag.
4545

4646
The following parameters govern the use of the returned proxy instance.
@@ -142,9 +142,6 @@ between conformable Python objects and XML on the wire.
142142
via XML-RPC, use :class:`bytes` or :class:`bytearray` classes or the
143143
:class:`Binary` wrapper class described below.
144144

145-
:class:`Server` is retained as an alias for :class:`ServerProxy` for backwards
146-
compatibility. New code should use :class:`ServerProxy`.
147-
148145
.. versionchanged:: 3.5
149146
Added the *context* argument.
150147

@@ -156,6 +153,17 @@ between conformable Python objects and XML on the wire.
156153
See https://ws.apache.org/xmlrpc/types.html for a description.
157154

158155

156+
.. class:: Server
157+
158+
Retained as an alias for :class:`ServerProxy` for backwards compatibility.
159+
New code should use :class:`ServerProxy`.
160+
161+
162+
.. exception:: Error
163+
164+
Base class of the :exc:`Fault` and :exc:`ProtocolError` exceptions.
165+
166+
159167
.. seealso::
160168

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

183191
Servers that support the XML introspection API support some common methods
184-
grouped under the reserved :attr:`~ServerProxy.system` attribute:
192+
grouped under the reserved :attr:`!system` attribute:
185193

186194

187195
.. method:: ServerProxy.system.listMethods()

‎Doc/tools/.nitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,4 @@ Doc/library/wsgiref.rst
2424
Doc/library/xml.dom.minidom.rst
2525
Doc/library/xml.sax.reader.rst
2626
Doc/library/xml.sax.rst
27-
Doc/library/xmlrpc.client.rst
2827
Doc/library/xmlrpc.server.rst

0 commit comments

Comments
 (0)