GNU bug report logs - #56243
[PATCH] gnu: python-debug: Improve description and synopsis.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 56243 in the body.
You can then email your comments to 56243 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: jgart <jgart <at> dismail.de>
To: guix-patches <at> gnu.org
Cc: jgart <jgart <at> dismail.de>
Subject: [PATCH] gnu: python-debug: Improve description and synopsis.
Date: Sun, 26 Jun 2022 17:09:38 -0500

* 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(-)

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

Message #8 received at 56243 <at> debbugs.gnu.org (full text, mbox):

From: Maxime Devos <maximedevos <at> telenet.be>
To: jgart <jgart <at> dismail.de>, 56243 <at> debbugs.gnu.org
Subject: Re: [bug#56243] [PATCH] gnu: python-debug: Improve description and
 synopsis.
Date: Mon, 27 Jun 2022 00:40:34 +0200

[Message part 1 (text/plain, inline)]

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?

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

Message #13 received at 56243-done <at> debbugs.gnu.org (full text, mbox):

From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 56243-done <at> debbugs.gnu.org, jgart <jgart <at> dismail.de>
Subject: Re: bug#56243: [PATCH] gnu: python-debug: Improve description and
 synopsis.
Date: Fri, 15 Jul 2022 23:54:25 -0400

Hi,

Maxime Devos <maximedevos <at> telenet.be> writes:

> 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

Message #16 received at 56243-done <at> debbugs.gnu.org (full text, mbox):

From: jgart <jgart <at> dismail.de>
To: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
Cc: 56243-done <at> debbugs.gnu.org, Maxime Devos <maximedevos <at> telenet.be>
Subject: Re: bug#56243: [PATCH] gnu: python-debug: Improve description and
 synopsis.
Date: Fri, 15 Jul 2022 23:04:25 -0500

On Fri, 15 Jul 2022 23:54:25 -0400 Maxim Cournoyer <maxim.cournoyer <at> gmail.com> wrote:
> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.