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

Jump to bottom
Merged
erlend-aasland merged 4 commits into from
Jun 26, 2023
Merged

Add guidelines for C API return values #1123

erlend-aasland merged 4 commits into from
Jun 26, 2023

Conversation

@erlend-aasland
Copy link
Contributor

@erlend-aaslanderlend-aasland commented Jun 23, 2023•
edited by github-actions bot
Loading

@erlend-aaslanderlend-aasland linked an issue Jun 23, 2023 that may be closed by this pull request
Document the preferred style for API functions with three, four or five-way returns #1121
Closed
@erlend-aaslanderlend-aasland mentioned this pull request Jun 23, 2023
Closed
markshannon
markshannon approved these changes Jun 23, 2023
View reviewed changes
Copy link
Member

@markshannonmarkshannon left a comment

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.

@erlend-aaslanderlend-aasland mentioned this pull request Jun 23, 2023
Closed
@erlend-aaslanderlend-aasland linked an issue Jun 23, 2023 that may be closed by this pull request
Document that infallible functions should be avoided #1122
Closed
vstinner
vstinner reviewed Jun 23, 2023
View reviewed changes
CAM-Gerlach
CAM-Gerlach reviewed Jun 23, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

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

CAM-Gerlach
CAM-Gerlach approved these changes Jun 23, 2023
View reviewed changes
Copy link
Member

@CAM-GerlachCAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @erlend-aasland !

This was referenced Jun 24, 2023
Open
Open
@erlend-aasland
Copy link
ContributorAuthor

erlend-aasland commented Jun 25, 2023

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

vstinner
vstinner approved these changes Jun 26, 2023
View reviewed changes
Copy link
Member

@vstinnervstinner left a comment

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
ContributorAuthor

erlend-aasland commented Jun 26, 2023

Thanks for the reviews!

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

@erlend-aaslanderlend-aasland merged commit 3f08d25 into python:mainJun 26, 2023
@erlend-aaslanderlend-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

Reviewers

@vstinnervstinnervstinner approved these changes

@markshannonmarkshannonmarkshannon approved these changes

@CAM-GerlachCAM-GerlachCAM-Gerlach approved these changes

@encukouencukouAwaiting requested review from encukou

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

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