From b239805204b42c603a406a5ae0e2b6a867b330ac Mon Sep 17 00:00:00 2001 From: ram vikram singh Date: Wed, 9 Nov 2022 19:17:20 +0530 Subject: [PATCH 1/6] gh-98930: updating the doc of dignal module --- Modules/signalmodule.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c index bdd3f4b2204ef4..a95fde4f0f0f71 100644 --- a/Modules/signalmodule.c +++ b/Modules/signalmodule.c @@ -627,7 +627,9 @@ 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. +Return the system description of the 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 * From dc62d33b880d94956b15f10da618eb4a25edd651 Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Wed, 9 Nov 2022 13:51:58 +0000 Subject: [PATCH 2/6] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20blu?= =?UTF-8?q?rb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst diff --git a/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst b/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst new file mode 100644 index 00000000000000..5eaa0084774272 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst @@ -0,0 +1 @@ +Changed the doc of signalmodule for making it understandable to users when it raises ValueError, when it returns None etc. From 25e623167ac0b0fab260f877b450831c1abf332f Mon Sep 17 00:00:00 2001 From: "Gregory P. Smith" Date: Sun, 13 Nov 2022 11:00:44 -0800 Subject: [PATCH 3/6] minor wording tweaks. --- Modules/signalmodule.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c index a95fde4f0f0f71..bfcc0a905f4dfb 100644 --- a/Modules/signalmodule.c +++ b/Modules/signalmodule.c @@ -626,10 +626,9 @@ signal.strsignal Return the system description of the given signal. -The return values can be such as "Interrupt", "Segmentation fault", etc. -Return the system description of the signal *signalnum*, such as -"Interrupt" for :const:`SIGINT`. Returns :const:`None` if *signalnum* has -no description. Raises :exc:`ValueError` if *signalnum* is invalid. +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 * From 53c1bd4b0f0dc604407d882d4eb18531c9fef090 Mon Sep 17 00:00:00 2001 From: "Gregory P. Smith" Date: Sun, 13 Nov 2022 11:02:10 -0800 Subject: [PATCH 4/6] doc update, no news entry required. --- .../Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst diff --git a/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst b/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst deleted file mode 100644 index 5eaa0084774272..00000000000000 --- a/Misc/NEWS.d/next/Documentation/2022-11-09-13-51-57.gh-issue-98930.Qj67r0.rst +++ /dev/null @@ -1 +0,0 @@ -Changed the doc of signalmodule for making it understandable to users when it raises ValueError, when it returns None etc. From 46591d636c9c48866d85954e4ad5baee721b7b34 Mon Sep 17 00:00:00 2001 From: "Gregory P. Smith [Google]" Date: Sun, 13 Nov 2022 19:07:07 +0000 Subject: [PATCH 5/6] python Tools/clinic/clinic.py -f Modules/signalmodule.c --- Modules/clinic/signalmodule.c.h | 7 ++++--- Modules/signalmodule.c | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Modules/clinic/signalmodule.c.h b/Modules/clinic/signalmodule.c.h index f0276c63df18f2..3b3c6ba150a1ad 100644 --- a/Modules/clinic/signalmodule.c.h +++ b/Modules/clinic/signalmodule.c.h @@ -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 @@ signal_pidfd_send_signal(PyObject *module, PyObject *const *args, Py_ssize_t nar #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]*/ diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c index bfcc0a905f4dfb..c539787e5829dd 100644 --- a/Modules/signalmodule.c +++ b/Modules/signalmodule.c @@ -633,7 +633,7 @@ description. Raises :exc:`ValueError` if *signalnum* is invalid. 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; From d8ea710fc2d803bfe81a75aba23fe1480b26e051 Mon Sep 17 00:00:00 2001 From: "Gregory P. Smith [Google]" Date: Sun, 13 Nov 2022 19:12:06 +0000 Subject: [PATCH 6/6] also update the docs --- Doc/library/signal.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 2269f50cbaff99..6cca760583cc30 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -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