Skip to content

gh-121533: Improve PyCell_[Get,Set] docs: mention the exceptions #121534

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 4 commits into from
Jul 9, 2024
Merged

gh-121533: Improve PyCell_[Get,Set] docs: mention the exceptions #121534

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33c3ac8
gh-121533: Improve `PyCell_[Get,Set]` docs: mention the exceptions
sobolevn Jul 9, 2024
4c4061b
Address review
sobolevn Jul 9, 2024
4646d5b
Update Doc/c-api/cell.rst
sobolevn Jul 9, 2024
f0af93f
Update cell.rst
sobolevn Jul 9, 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
9 changes: 6 additions & 3 deletions Doc/c-api/cell.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ Cell objects are not likely to be useful elsewhere.

.. c:function:: PyObject* PyCell_Get(PyObject *cell)

Return the contents of the cell *cell*.
Return the contents of the cell *cell*, which can be ``NULL``.
If *cell* is not a cell object, returns ``NULL`` with an exception set.


.. c:function:: PyObject* PyCell_GET(PyObject *cell)
Expand All @@ -52,8 +53,10 @@ Cell objects are not likely to be useful elsewhere.

Set the contents of the cell object *cell* to *value*. This releases the
reference to any current content of the cell. *value* may be ``NULL``. *cell*
must be non-``NULL``; if it is not a cell object, ``-1`` will be returned. On
success, ``0`` will be returned.
must be non-``NULL``.

On success, return ``0``.
If *cell* is not a cell object, set an exception and return ``-1``.


.. c:function:: void PyCell_SET(PyObject *cell, PyObject *value)
Expand Down