Skip to content

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

Merged
sobolevn merged 2 commits into
python:mainfrom
sobolevn:issue-121615
Jul 11, 2024
Merged

gh-121615: Improve module.rst C-API docs with better error descriptions#121616
sobolevn merged 2 commits into
python:mainfrom
sobolevn:issue-121615

Conversation

@sobolevn

@sobolevn sobolevn commented Jul 11, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@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
@bedevere-app bedevere-app Bot mentioned this pull request Jul 11, 2024
Closed
@erlend-aasland

erlend-aasland commented Jul 11, 2024

Copy link
Copy Markdown
Contributor

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

@sobolevn

sobolevn commented Jul 11, 2024

Copy link
Copy Markdown
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

erlend-aasland commented Jul 11, 2024

Copy link
Copy Markdown
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
@miss-islington-app

miss-islington-app Bot commented Jul 11, 2024

Copy link
Copy Markdown

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
@sobolevn @miss-islington
pythongh-121615: Improve module.rst C-API docs with better error de…
0c34a05 
…scriptions (pythonGH-121616)

(cherry picked from commit e6264b4)

Co-authored-by: sobolevn <mail@sobolevn.me>
@miss-islington-app

miss-islington-app Bot commented Jul 11, 2024

Copy link
Copy Markdown

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

bedevere-app Bot commented Jul 11, 2024

Copy link
Copy Markdown

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
@sobolevn
[3.12] pythongh-121615: Improve module.rst C-API docs with better e…
8a6a3f8 
…rror descriptions (pythonGH-121616)

(cherry picked from commit e6264b4)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app

bedevere-app Bot commented Jul 11, 2024

Copy link
Copy Markdown

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
[3.12] gh-121615: Improve module.rst C-API docs with better error d…
5492f84 
…escriptions (GH-121616) (#121619)

(cherry picked from commit e6264b4)
sobolevn added a commit that referenced this pull request Jul 11, 2024
@miss-islington @sobolevn
[3.13] gh-121615: Improve module.rst C-API docs with better error d…
261c8e9 
…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 <mail@sobolevn.me>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
@sobolevn @noahbkim
pythongh-121615: Improve module.rst C-API docs with better error de…
2b991c9 
…scriptions (python#121616)
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@sobolevn @estyxx
pythongh-121615: Improve module.rst C-API docs with better error de…
8c7b1ea 
…scriptions (python#121616)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erlend-aasland erlend-aasland erlend-aasland approved these changes
@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

Assignees

@sobolevn sobolevn

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sobolevn @erlend-aasland