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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: jgart <jgart <at> dismail.de>
Subject: bug#56243: closed (Re: bug#56243: [PATCH] gnu: python-debug:
 Improve description and synopsis.)
Date: Sat, 16 Jul 2022 03:55:02 +0000

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

Your bug report

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

which was filed against the guix-patches package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 56243 <at> debbugs.gnu.org.

-- 
56243: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=56243
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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

Previous Next

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