Skip to content

gh-144257: document return values of PyModule_SetDocString #144258

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
ZeroIntensity merged 4 commits into from
Jan 27, 2026
Merged

gh-144257: document return values of PyModule_SetDocString #144258

ZeroIntensity merged 4 commits into from
Jan 27, 2026
+3 −0

Conversation

@ngoldbaum
Copy link
Contributor

@ngoldbaum ngoldbaum commented Jan 26, 2026 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Jan 26, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jan 26, 2026
@bedevere-app bedevere-app bot mentioned this pull request Jan 26, 2026
Closed
sobolevn
sobolevn reviewed Jan 26, 2026
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I propose to simplify the wording. And I propose to not go into the details about why an error can happen :)

@ngoldbaum @sobolevn
Update module.rst
f817431 
Co-authored-by: sobolevn <mail@sobolevn.me>
ngoldbaum
ngoldbaum commented Jan 26, 2026
View reviewed changes
ngoldbaum
ngoldbaum commented Jan 26, 2026
View reviewed changes
@ngoldbaum ngoldbaum changed the title gh-144257: document return values and failure conditions of PyModule_SetDocString gh-144257: document return values of PyModule_SetDocString Jan 26, 2026
sobolevn
sobolevn approved these changes Jan 26, 2026
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Thank you!

I will keep this open for a bit, so others can also take a look :)
And merge it in several days.

@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 27, 2026
@ZeroIntensity ZeroIntensity merged commit 3e9a5b0 into python:main Jan 27, 2026
37 checks passed
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 27, 2026

Thanks @ngoldbaum for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jan 27, 2026
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 27, 2026
@ngoldbaum @sobolevn @miss-islington
pythongh-144257: document return values of PyModule_SetDocString (pyt…
ac5cc4f 
…honGH-144258)

(cherry picked from commit 3e9a5b0)

Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 27, 2026

Sorry, @ngoldbaum and @ZeroIntensity, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 3e9a5b022f01fa95b4485fcf2c0c87bfb9fff837 3.13

@bedevere-app
Copy link

bedevere-app bot commented Jan 27, 2026

GH-144263 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jan 27, 2026
@ZeroIntensity
Copy link
Member

ZeroIntensity commented Jan 27, 2026

@ngoldbaum Would you mind handling the 3.13 backport?

ZeroIntensity pushed a commit that referenced this pull request Jan 27, 2026
@miss-islington @ngoldbaum @sobolevn
[3.14] gh-144257: document return values of PyModule_SetDocString (GH…
7af0d06 
…-144258) (GH-144263)

gh-144257: document return values of PyModule_SetDocString (GH-144258)
(cherry picked from commit 3e9a5b0)

Co-authored-by: Nathan Goldbaum <nathan.goldbaum@gmail.com>
Co-authored-by: sobolevn <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sergey-miryanov sergey-miryanov sergey-miryanov approved these changes

@sobolevn sobolevn sobolevn approved these changes

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

Assignees

@ZeroIntensity ZeroIntensity

Labels

docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ngoldbaum @ZeroIntensity @sergey-miryanov @sobolevn