Skip to content

gh-98930: improve the docstring of signal.strsignal#99290

Merged
gpshead merged 6 commits into
python:mainfrom
ramvikrams:t00
Nov 13, 2022
Merged

gh-98930: improve the docstring of signal.strsignal#99290
gpshead merged 6 commits into
python:mainfrom
ramvikrams:t00

Conversation

@ramvikrams
Copy link
Copy Markdown
Contributor

@ramvikrams ramvikrams commented Nov 9, 2022 •
edited by gpshead
Loading

gh-98930: Improved the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.

Closes #98930

@bedevere-bot bedevere-bot mentioned this pull request Nov 9, 2022
Closed
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Nov 9, 2022

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@gpshead gpshead changed the title gh-98930: updating the doc of dignal module gh-98930: updating the doc of signal module Nov 13, 2022
@gpshead gpshead added docs Documentation in the Doc dir skip news labels Nov 13, 2022
@gpshead gpshead changed the title gh-98930: updating the doc of signal module gh-98930: improve the docstring of signal.strsignal Nov 13, 2022
@gpshead gpshead self-assigned this Nov 13, 2022
@gpshead gpshead merged commit 88385b8 into python:main Nov 13, 2022
@gpshead gpshead added the needs backport to 3.11 only security fixes label Nov 13, 2022
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Nov 13, 2022

Thanks @ramvikrams for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Nov 13, 2022

Sorry, @ramvikrams and @gpshead, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 88385b856490a5ce3c99160bde6050638f81f72e 3.11

@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Nov 13, 2022

GH-99449 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Nov 13, 2022
gpshead pushed a commit to gpshead/cpython that referenced this pull request Nov 13, 2022
@ramvikrams @gpshead
[3.11] pythongh-98930: improve the docstring of signal.strsignal (pyt…
0a227b0 
…honGH-99290)

Improves the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.

Closes pythonGH-98930

Co-authored-by: Gregory P. Smith <[email protected]>.
(cherry picked from commit 88385b8)

Co-authored-by: ram vikram singh <[email protected]>
gpshead added a commit that referenced this pull request Nov 13, 2022
@gpshead @ramvikrams
[3.11] gh-98930: improve the docstring of signal.strsignal (GH-99290) (…
51c68cf 
…#99449)

Improves the docstring on signal.strsignal to make it explain when it returns a message, None, or when it raises ValueError.

Closes GH-98930

Co-authored-by: Gregory P. Smith <[email protected]>.
(cherry picked from commit 88385b8)

Co-authored-by: ram vikram singh <[email protected]>
@ramvikrams ramvikrams deleted the t00 branch November 30, 2022 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gpshead gpshead gpshead approved these changes

Assignees

@gpshead gpshead

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.

signal.strsignal(...) doesn't really return None if signal is not recognized

4 participants

@ramvikrams @bedevere-bot @miss-islington @gpshead