Skip to content

gh-121615: Improve module.rst C-API docs with better error descriptions #121616

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.

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 2 commits into from
Jul 11, 2024

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Jul 11, 2024

@sobolevn sobolevn requested a review from erlend-aasland July 11, 2024 07:49
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Jul 11, 2024
@erlend-aasland
Copy link
Contributor

Should we normalise the wording? Currently, there's a slight variance in wording.

@sobolevn
Copy link
Member Author

Currently, there's a slight variance in wording.

I don't think that this is a hard requirement, but I normalized mine wordings.
The phrase is simple enough to be understood in different possible wordings and I think that this is the main thing that matters :)

@erlend-aasland
Copy link
Contributor

Yeah, I know, and I didn't mean to imply it as a hard requirement; I was just pondering if it made sense to normalise them :)

@sobolevn sobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jul 11, 2024
@sobolevn sobolevn merged commit e6264b4 into python:main Jul 11, 2024
29 checks passed
@miss-islington-app
Copy link

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 11, 2024
…scriptions (pythonGH-121616)

(cherry picked from commit e6264b4)

Co-authored-by: sobolevn <[email protected]>
@miss-islington-app
Copy link

Sorry, @sobolevn, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker e6264b44dc7221c713b14dfa0f5929b33d362829 3.12

@bedevere-app
Copy link

bedevere-app bot commented Jul 11, 2024

GH-121618 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 11, 2024
sobolevn added a commit to sobolevn/cpython that referenced this pull request Jul 11, 2024
…rror descriptions (pythonGH-121616)

(cherry picked from commit e6264b4)

Co-authored-by: sobolevn <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jul 11, 2024

GH-121619 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jul 11, 2024
sobolevn added a commit that referenced this pull request Jul 11, 2024
sobolevn added a commit that referenced this pull request Jul 11, 2024
…escriptions (GH-121616) (#121618)

gh-121615: Improve `module.rst` C-API docs with better error descriptions (GH-121616)
(cherry picked from commit e6264b4)

Co-authored-by: sobolevn <[email protected]>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants