Skip to content

gh-101100: Fix Sphinx warnings in c-api/structures.rst #113564

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
hugovk merged 5 commits into from
Jan 24, 2024
Merged

gh-101100: Fix Sphinx warnings in c-api/structures.rst #113564

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0187af8
Fix Sphinx warnings in c-api/structures.rst
hugovk Dec 29, 2023
3405b9b
Use the proper directives for `getter` and `setter`
encukou Jan 24, 2024
aefc58c
Use ``NULL`` rather than "omitted" for a C field
encukou Jan 24, 2024
c8725cf
All warnings fixedd in Doc/c-api/structures.rst
hugovk Jan 24, 2024
fbba9a4
Hyphenate read-only
hugovk Jan 24, 2024
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
Prev Previous commit
Next Next commit
Use the proper directives for getter and setter
  • Loading branch information
@encukou
encukou committed Jan 24, 2024
commit 3405b9bc16999c581bdf390b4cc4a6e521b24fc2
12 changes: 6 additions & 6 deletions Doc/c-api/structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,18 +669,18 @@ Defining Getters and Setters

Optional function pointer, providing additional data for getter and setter.

The ``get`` function takes one :c:expr:`PyObject*` parameter (the
instance) and a function pointer (the associated ``closure``)::
.. c:type:: PyObject *(*getter)(PyObject *, void *)

typedef PyObject *(*getter)(PyObject *, void *);
The ``get`` function takes one :c:expr:`PyObject*` parameter (the
instance) and a function pointer (the associated ``closure``):

It should return a new reference on success or ``NULL`` with a set exception
on failure.

``set`` functions take two :c:expr:`PyObject*` parameters (the instance and
the value to be set) and a function pointer (the associated ``closure``)::
.. c:type:: int (*setter)(PyObject *, PyObject *, void *)

typedef int (*setter)(PyObject *, PyObject *, void *);
``set`` functions take two :c:expr:`PyObject*` parameters (the instance and
the value to be set) and a function pointer (the associated ``closure``):

In case the attribute should be deleted the second parameter is ``NULL``.
Should return ``0`` on success or ``-1`` with a set exception on failure.