Skip to content

Add guidelines for C API return values - #1123

Merged
erlend-aasland merged 4 commits into
python:mainfrom
erlend-aasland:c-api/guidelines-return-value
Jun 26, 2023
Merged

Add guidelines for C API return values#1123
erlend-aasland merged 4 commits into
python:mainfrom
erlend-aasland:c-api/guidelines-return-value

Conversation

@erlend-aasland

@erlend-aaslanderlend-aasland commented Jun 23, 2023

Copy link
Copy Markdown
Contributor

@markshannonmarkshannon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me, as a first step.

Comment threaddeveloper-workflow/c-api.rst

@CAM-GerlachCAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A couple small textual tweaks, otherwise LGTM

Comment threaddeveloper-workflow/c-api.rst Outdated
Comment threaddeveloper-workflow/c-api.rst Outdated
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

@CAM-GerlachCAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks @erlend-aasland !

@erlend-aasland

Copy link
Copy Markdown
ContributorAuthor

Unless there are further remarks, I consider landing this early the coming week.

@vstinnervstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@erlend-aasland

Copy link
Copy Markdown
ContributorAuthor

Thanks for the reviews!

FTR, I also got a thumbs up by Thomas Wouters for this PR.

@erlend-aasland
erlend-aasland merged commit 3f08d25 into python:mainJun 26, 2023
@erlend-aasland
erlend-aasland deleted the c-api/guidelines-return-value branch June 26, 2023 07:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document that infallible functions should be avoided Document the preferred style for API functions with three, four or five-way returns

4 participants

@erlend-aasland@vstinner@markshannon@CAM-Gerlach