Skip to content

gh-141004: Document PyFunction_SetKwDefaults #141294

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
ZeroIntensity merged 2 commits into from
Nov 9, 2025
+9 −0
Merged

gh-141004: Document PyFunction_SetKwDefaults #141294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4698e1
Document PyFunction_SetKwDefaults().
ZeroIntensity Nov 9, 2025
bdbc304
This is a setter, not a getter.
ZeroIntensity Nov 9, 2025
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: 9 additions & 0 deletions Doc/c-api/function.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ There are a few functions specific to Python functions.
dictionary of arguments or ``NULL``.


.. c:function:: int PyFunction_SetKwDefaults(PyObject *op, PyObject *defaults)

Set the keyword-only argument default values of the function object *op*.
*defaults* must be a dictionary of keyword-only arguments or ``Py_None``.
Comment on lines +107 to +108
Copy link
Member

@StanFromIreland StanFromIreland Nov 9, 2025

Choose a reason for hiding this comment

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

Suggested change
Set the keyword-only argument default values of the function object *op*.
*defaults* must be a dictionary of keyword-only arguments or ``Py_None``.
Set the keyword-only parameter default values of the function object *op*.
*defaults* must be a dictionary of keyword-only parameters or ``Py_None``.

Copy link
Member Author

@ZeroIntensity ZeroIntensity Nov 9, 2025

Choose a reason for hiding this comment

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

We say "argument" everywhere else in this file, so I'd rather not deviate from it here. I don't think that the distinction is particularly helpful for readers here.

Copy link
Member

@StanFromIreland StanFromIreland Nov 9, 2025

Choose a reason for hiding this comment

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

I'm not a fan of such a precedent, but unfortunately it is. Fixing this is tracked in #133438.


This function returns ``0`` on success, and returns ``-1`` with an exception
set on failure.


.. c:function:: PyObject* PyFunction_GetClosure(PyObject *op)

Return the closure associated with the function object *op*. This can be ``NULL``
Expand Down
Loading