[Python-checkins] bpo-43354: xmlrpc: Fix type documentation for Fault.faultCode (GH-24707)

miss-islington webhook-mailer at python.org
Fri Mar 26 17:09:18 EDT 2021


https://github.com/python/cpython/commit/027b6699276ed8d9f68425697ac89bf61e54e6b9
commit: 027b6699276ed8d9f68425697ac89bf61e54e6b9
branch: master
author: Jürgen Gmach <juergen.gmach at googlemail.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-03-26T14:09:09-07:00
summary:

bpo-43354: xmlrpc: Fix type documentation for Fault.faultCode (GH-24707)



The type of `faultCode` has to be an `int` instead of a `str`.

cf http://xmlrpc.com/spec.md

Pinging @pganssle

files:
A Misc/NEWS.d/next/Documentation/2021-03-02-12-55-34.bpo-43354.ezZYkx.rst
M Doc/library/xmlrpc.client.rst

diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst
index 32403819531aa..51279b35fd71b 100644
--- a/Doc/library/xmlrpc.client.rst
+++ b/Doc/library/xmlrpc.client.rst
@@ -378,7 +378,7 @@ Fault Objects
 
    .. attribute:: faultCode
 
-      A string indicating the fault type.
+      An int indicating the fault type.
 
 
    .. attribute:: faultString
diff --git a/Misc/NEWS.d/next/Documentation/2021-03-02-12-55-34.bpo-43354.ezZYkx.rst b/Misc/NEWS.d/next/Documentation/2021-03-02-12-55-34.bpo-43354.ezZYkx.rst
new file mode 100644
index 0000000000000..1a8743cbde615
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-03-02-12-55-34.bpo-43354.ezZYkx.rst
@@ -0,0 +1 @@
+Fix type documentation for ``Fault.faultCode``; the type has to be ``int`` instead of ``str``.
\ No newline at end of file



More information about the Python-checkins mailing list