Skip to content

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

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

Merged
merged 6 commits into from
Nov 13, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b239805
gh-98930: updating the doc of dignal module
ramvikrams Nov 9, 2022
dc62d33
📜🤖 Added by blurb_it.
blurb-it[bot] Nov 9, 2022
25e6231
minor wording tweaks.
gpshead Nov 13, 2022
53c1bd4
doc update, no news entry required.
gpshead Nov 13, 2022
46591d6
python Tools/clinic/clinic.py -f Modules/signalmodule.c
gpshead Nov 13, 2022
d8ea710
also update the docs
gpshead Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Doc/library/signal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,9 +362,9 @@ The :mod:`signal` module defines the following functions:

.. function:: strsignal(signalnum)

Return the system description of the signal *signalnum*, such as
"Interrupt", "Segmentation fault", etc. Returns :const:`None` if the signal
is not recognized.
Returns the description of signal *signalnum*, such as "Interrupt"
for :const:`SIGINT`. Returns :const:`None` if *signalnum* has no
description. Raises :exc:`ValueError` if *signalnum* is invalid.

.. versionadded:: 3.8

Expand Down
7 changes: 4 additions & 3 deletions Modules/clinic/signalmodule.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions Modules/signalmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,13 +626,14 @@ signal.strsignal

Return the system description of the given signal.

The return values can be such as "Interrupt", "Segmentation fault", etc.
Returns None if the signal is not recognized.
Returns the description of signal *signalnum*, such as "Interrupt"
for :const:`SIGINT`. Returns :const:`None` if *signalnum* has no
description. Raises :exc:`ValueError` if *signalnum* is invalid.
[clinic start generated code]*/

static PyObject *
signal_strsignal_impl(PyObject *module, int signalnum)
/*[clinic end generated code: output=44e12e1e3b666261 input=b77914b03f856c74]*/
/*[clinic end generated code: output=44e12e1e3b666261 input=238b335847778bc0]*/
{
const char *res;

Expand Down