[PATCH] gnu: python-debug: Improve description and synopsis.

DoneSubmitted by jgart.
Details
3 participants
  • jgart
  • Maxim Cournoyer
  • Maxime Devos
Owner
unassigned
Severity
normal
J
(address . guix-patches@gnu.org)(name . jgart)(address . jgart@dismail.de)
20220626220938.12896-1-jgart@dismail.de
* gnu/packages/python.scm (python-debug): Improve description and
synopsis.
[synopsis]: Improve synopsis.
[description]: Improve description.
---
gnu/packages/python.scm | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)

Toggle diff (21 lines)
diff --git a/gnu/packages/python.scm b/gnu/packages/python.scm
index ad475d8acc..6611e13096 100644
--- a/gnu/packages/python.scm
+++ b/gnu/packages/python.scm
@@ -617,10 +617,11 @@ (define-public python-debug
        ((#:configure-flags flags '())
         `(cons "--with-pydebug" ,flags))))
     (synopsis
-     "High-level, dynamically-typed programming language (for debugging)")
+     "Python with the debug hooks enabled")
     (description
-     "This variant of Python provides an interpreter built with
-@code{--with-pydebug} to help develop and debug extensions.  See
+"This variant of Python provides an interpreter
+built with the @code{--with-pydebug} flag, enabling
+debug hooks for development or testing purposes.  See
 @url{https://pythonextensionpatterns.readthedocs.io/en/latest/debugging/debug.html},
 for more information.")))
 
-- 
2.36.1
M
M
Maxime Devos wrote on 27 Jun 00:40 +0200
19be37371b7a8e551cad80d45aa839e811f9c542.camel@telenet.be
jgart via Guix-patches via schreef op zo 26-06-2022 om 17:09 [-0500]:
Toggle quote (12 lines)
>      (synopsis
> -     "High-level, dynamically-typed programming language (for debugging)")
> +     "Python with the debug hooks enabled")
>      (description
> -     "This variant of Python provides an interpreter built with
> -@code{--with-pydebug} to help develop and debug extensions.  See
> +"This variant of Python provides an interpreter
> +built with the @code{--with-pydebug} flag, enabling
> +debug hooks for development or testing purposes.  See
>  @url{https://pythonextensionpatterns.readthedocs.io/en/latest/debugging/debug.html},
>  for more information.")))

I can't tell whether the old or new description is better but the new
synopsis seems better to me (more to the point and descriptive -- you
can do debugging in the regular python too!). Maybe it would be even
better to make clear in the description that you can also do debugging
with the _regular_ python package?

Greetings,
Maxime.
-----BEGIN PGP SIGNATURE-----

iI0EABYKADUWIQTB8z7iDFKP233XAR9J4+4iGRcl7gUCYrjgYhccbWF4aW1lZGV2
b3NAdGVsZW5ldC5iZQAKCRBJ4+4iGRcl7p0NAQClOtJD11CM/wBPJQu/Q7Oq+amc
DN1FlvYWuzxcyOTcSQD/bPzb6dwm4E7kAUST7wd2rvdIsAlkCtg3EyGMhS7FtQs=
=W48x
-----END PGP SIGNATURE-----


M
M
Maxim Cournoyer wrote on 16 Jul 05:54 +0200
Re: bug#56243: [PATCH] gnu: python-debug: Improve description and synopsis.
(name . Maxime Devos)(address . maximedevos@telenet.be)
87ilnxr9u6.fsf_-_@gmail.com
Hi,

Maxime Devos <maximedevos@telenet.be> writes:

Toggle quote (19 lines)
> jgart via Guix-patches via schreef op zo 26-06-2022 om 17:09 [-0500]:
>>      (synopsis
>> -     "High-level, dynamically-typed programming language (for debugging)")
>> +     "Python with the debug hooks enabled")
>>      (description
>> -     "This variant of Python provides an interpreter built with
>> -@code{--with-pydebug} to help develop and debug extensions.  See
>> +"This variant of Python provides an interpreter
>> +built with the @code{--with-pydebug} flag, enabling
>> +debug hooks for development or testing purposes.  See
>>  @url{https://pythonextensionpatterns.readthedocs.io/en/latest/debugging/debug.html},
>>  for more information.")))
>
> I can't tell whether the old or new description is better but the new
> synopsis seems better to me (more to the point and descriptive -- you
> can do debugging in the regular python too!). Maybe it would be even
> better to make clear in the description that you can also do debugging
> with the _regular_ python package?

I pushed the improved synopsis, but also had doubts about the
description change, so left it out in
15943fa75788edb8d9ed1c3d8d320f50d21e4baa.

Closing.

Thanks,

Maxim
Closed
J
(name . Maxim Cournoyer)(address . maxim.cournoyer@gmail.com)
20220715230425.GB1120@gac
On Fri, 15 Jul 2022 23:54:25 -0400 Maxim Cournoyer <maxim.cournoyer@gmail.com> wrote:
Toggle quote (4 lines)
> I pushed the improved synopsis, but also had doubts about the
> description change, so left it out in
> 15943fa75788edb8d9ed1c3d8d320f50d21e4baa.

Hi Maxim,

Sorry I couldn't get to it in time but thanks for working on it.

all best,

jgart
Closed
?