GNU bug report logs - #50076
[PATCH 0/1] Add python-flask-debugtoolbar.

Previous Next

Full log

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

From: Bonface Munyoki K. <me <at> bonfacemunyoki.com>
To: Arun Isaac <arunisaac <at> systemreboot.net>
Cc: 50076 <at> debbugs.gnu.org
Subject: Re: [bug#50076] [PATCH 1/1] gnu: Add python-flask-debugtoolbar.
Date: Fri, 27 Aug 2021 14:14:12 +0300

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

Arun Isaac <arunisaac <at> systemreboot.net> anaandika:

> Hi Bonface,
>
> Thanks for contributing! :-) Some feedback follows.
>
> 1. Please add a copyright header.

Cool. Thanks for the gentle reminder.

> 2. Could you try packaging the tests? I think tests use
> pytest. Currently, no tests are run during the check phase.
>

Cool. I'll try to work out how to do that.

>> +  (synopsis
>> +    "A toolbar overlay for debugging Flask applications.")
>
> 3. Could you remove the article "A" at the beginning, and the period at
> the end? Quoting from our manual at "(guix) Synopses and Descriptions":
>
>    Synopses must start with a capital letter and must not end with a
> period.  They must not start with “a” or “the”, which usually does not
> bring anything; for instance, prefer “File-frobbing tool” over “A tool
> that frobs files”.
>
>
>> +  (description
>> +    "This extension adds a toolbar overlay to Flask applications containing
>> +useful information for debugging.")
>
> 4. Finally, a nitpick: It would be more consistent with the rest of Guix
> if the synopsis and description started on the same line instead of on
> the next. So, something like this:
>
>     (description "This extension adds a toolbar overlay to Flask applications
> containing useful information for debugging.")
>

Much thanks for the above suggestions! I'll work
on this and submit a revised patch over the
weekend.

-- 
Bonface M. K. D4F09EB110177E03C28E2FE1F5BBAE1E0392253F
Free Software Activist
Humble GNU Emacs User | Bearer of scheme-y parens
Curator: <https://upbookclub.com> | Twitter: @BonfaceKilz

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

Previous Next

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