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

Previous Next

Full log

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

From: Arun Isaac <arunisaac <at> systemreboot.net>
To: BonfaceKilz <me <at> bonfacemunyoki.com>
Cc: 50076 <at> debbugs.gnu.org
Subject: Re: [bug#50076] [PATCH 1/1] gnu: Add python-flask-debugtoolbar.
Date: Tue, 24 Aug 2021 02:23:03 +0530

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

Hi Bonface,

Thanks for contributing! :-) Some feedback follows.

1. Please add a copyright header.
2. Could you try packaging the tests? I think tests use
pytest. Currently, no tests are run during the check phase.

> +  (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":

--8<---------------cut here---------------start------------->8---
   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”.
--8<---------------cut here---------------end--------------->8---

> +  (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:

--8<---------------cut here---------------start------------->8---
    (description "This extension adds a toolbar overlay to Flask applications
containing useful information for debugging.")
--8<---------------cut here---------------end--------------->8---

Thanks!
Arun

[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.