-
-
Notifications
You must be signed in to change notification settings - Fork 33.4k
gh-140505: Correct "parameters" to "arguments" in MultiCall doc #140512
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.
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
base: main
Are you sure you want to change the base?
Conversation
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be changed in more places.
… module description
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there are more:
This method takes one parameter,
Signatures themselves are restricted to the top level parameters expected by a
method. For instance if a method expects one array of structs as a parameter,
And most likely:
a client can call methods with parameters
Method has parameters, but it expects and takes arguments.
done. thank you |
Doc/library/xmlrpc.client.rst
Outdated
|
|
||
| Signatures themselves are restricted to the top level parameters expected by a | ||
| method. For instance if a method expects one array of structs as a parameter, | ||
| method. For instance if a method expects one array of structs as a argument, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| method. For instance if a method expects one array of structs as a argument, | |
| method. For instance if a method expects one array of structs as an argument, |
Doc/library/xmlrpc.client.rst
Outdated
| Because multiple signatures (ie. overloading) is permitted, this method returns | ||
| a list of signatures rather than a singleton. | ||
|
|
||
| Signatures themselves are restricted to the top level parameters expected by a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would write something like "Note that a signature does not give details of a complex type; it just gives the basic XML-RPC type -- array or structure." (see https://xmlrpc-c.sourceforge.io/introspection.html).
This is applied not only to the types of parameters, but to the return type too.
Doc/library/xmlrpc.client.rst
Outdated
| method. For instance if a method expects one array of structs as a parameter, | ||
| method. For instance if a method expects one array of structs as a argument, | ||
| and it returns a string, its signature is simply "string, array". If it expects | ||
| three integers and returns a string, its signature is "string, int, int, int". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is applied to the return type too, I suggest to use this in the example.
| three integers and returns a string, its signature is "string, int, int, int". | |
| three integers and returns an array of strings, its signature is "array, int, int, int". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I’ve made the changes you suggested. The section now makes it clear that a signature only shows the top-level XML-RPC type (array or structure) for arguments and return values. Added a couple of examples to make it easier to understand
|
In June, the editorial board recommended not to make similar changes: |

📚 Documentation preview 📚: https://cpython-previews--140512.org.readthedocs.build/en/140512/library/xmlrpc.client.html#multicall-objects