Skip to content

Add guidelines for C API return values #1123

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
erlend-aasland merged 4 commits into from
Jun 26, 2023
Merged

Add guidelines for C API return values #1123

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91c2a05
Add guidelines for C API return values
erlend-aasland Jun 23, 2023
e4959a3
Be explicit about what a return value is
erlend-aasland Jun 23, 2023
1baa415
Wording
erlend-aasland Jun 23, 2023
8458b6f
Apply suggestions from CAM's review
erlend-aasland Jun 23, 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
Prev Previous commit
Next Next commit
Wording
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jun 23, 2023
commit 1baa415d6a75dc5262c0856ea4355f05607b4f4d
4 changes: 2 additions & 2 deletions developer-workflow/c-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ Guidelines for expanding/changing the public API
- Make sure the ownership rules and lifetimes of all applicable struct
fields, arguments and return values are well defined.

- Functions that return a ``PyObject *`` pointer must return a valid pointer
on success and ``NULL`` with an exception raised on error.
- Functions returning ``PyObject *`` must return a valid pointer on success
Comment thread
erlend-aasland marked this conversation as resolved.
Outdated
and ``NULL`` with an exception raised on error.
Most other API must return ``-1`` with an exception raised on error,
and ``0`` on success.

Expand Down