Skip to content

Conversation

@7576457
Copy link

@7576457 7576457 commented Oct 23, 2025

@python-cla-bot
Copy link

python-cla-bot bot commented Oct 23, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a 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.

@7576457
Copy link
Author

7576457 commented Oct 23, 2025

I think this should be changed in more places.

Yes, you’re right -- I found one more place where the term should be updated. Everything else seems fine
изображение

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a 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.

@7576457
Copy link
Author

7576457 commented Oct 25, 2025

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


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,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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,

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
Copy link
Member

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.

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".
Copy link
Member

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.

Suggested change
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".

Copy link
Author

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

@serhiy-storchaka serhiy-storchaka requested a review from a team October 27, 2025 16:57
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 27, 2025
@hugovk
Copy link
Member

hugovk commented Oct 28, 2025

In June, the editorial board recommended not to make similar changes:

#135160 (comment)

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

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants