Skip to content

gh-64658: Expand Argument Clinic return converter docs #104175

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

Merged
merged 7 commits into from
May 5, 2023
Merged

gh-64658: Expand Argument Clinic return converter docs #104175

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3de3972
gh-64658: Amend Argument Clinic return converter docs
erlend-aasland May 4, 2023
e7233a4
Fix init return converter name
erlend-aasland May 4, 2023
28876a7
Sort the return converter table alphabetically
erlend-aasland May 4, 2023
c361abd
Further amendments
erlend-aasland May 4, 2023
fc83243
Add example
erlend-aasland May 4, 2023
88ed3c1
Update Doc/howto/clinic.rst
erlend-aasland May 5, 2023
7e24669
Update Doc/howto/clinic.rst
erlend-aasland May 5, 2023
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
9 changes: 5 additions & 4 deletions Doc/howto/clinic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,16 +1069,17 @@ Currently Argument Clinic supports only a few return converters:
int
unsigned int
long
unsigned int
unsigned long
size_t
Py_ssize_t
float
double
DecodeFSDefault
__init__

None of these take parameters. For the first three, return -1 to indicate
error. For ``DecodeFSDefault``, the return type is ``const char *``; return a ``NULL``
pointer to indicate an error.
error.
The ``__init__`` converter is a special return converter for ``__init__``
functions.

To see all the return converters Argument Clinic supports, along with
their parameters (if any),
Expand Down