Skip to content
Snippets Groups Projects
Unverified Commit 88385b85 authored by ram vikram singh's avatar ram vikram singh Committed by GitHub
Browse files

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


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

Closes #98930

Co-authored-by: default avatarGregory P. Smith <greg@krypto.org>
parent 343eb0f9
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
......@@ -211,8 +211,9 @@ PyDoc_STRVAR(signal_strsignal__doc__,
"\n"
"Return the system description of the given signal.\n"
"\n"
"The return values can be such as \"Interrupt\", \"Segmentation fault\", etc.\n"
"Returns None if the signal is not recognized.");
"Returns the description of signal *signalnum*, such as \"Interrupt\"\n"
"for :const:`SIGINT`. Returns :const:`None` if *signalnum* has no\n"
"description. Raises :exc:`ValueError` if *signalnum* is invalid.");
#define SIGNAL_STRSIGNAL_METHODDEF \
{"strsignal", (PyCFunction)signal_strsignal, METH_O, signal_strsignal__doc__},
......@@ -704,4 +705,4 @@ exit:
#ifndef SIGNAL_PIDFD_SEND_SIGNAL_METHODDEF
#define SIGNAL_PIDFD_SEND_SIGNAL_METHODDEF
#endif /* !defined(SIGNAL_PIDFD_SEND_SIGNAL_METHODDEF) */
/*[clinic end generated code: output=f2a3321b32b0637c input=a9049054013a1b77]*/
/*[clinic end generated code: output=2b54dc607f6e3146 input=a9049054013a1b77]*/
......@@ -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;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment