unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Bonface Munyoki K. <me@bonfacemunyoki.com>
To: Arun Isaac <arunisaac@systemreboot.net>
Cc: 50076@debbugs.gnu.org
Subject: [bug#50076] [PATCH 1/1] gnu: Add python-flask-debugtoolbar.
Date: Fri, 27 Aug 2021 14:14:12 +0300	[thread overview]
Message-ID: <86r1eff8cb.fsf@bonfacemunyoki.com> (raw)
In-Reply-To: <87tujfrihc.fsf@systemreboot.net> (Arun Isaac's message of "Tue,  24 Aug 2021 02:23:03 +0530")

[-- Attachment #1: Type: text/plain, Size: 1658 bytes --]

Arun Isaac <arunisaac@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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 865 bytes --]

  reply	other threads:[~2021-08-27 11:15 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-16  9:47 [bug#50076] [PATCH 0/1] Add python-flask-debugtoolbar BonfaceKilz
2021-08-16  9:50 ` [bug#50076] [PATCH 1/1] gnu: " BonfaceKilz
2021-08-23 20:53   ` Arun Isaac
2021-08-27 11:14     ` Bonface Munyoki K. [this message]
2023-05-19  4:50 ` [bug#50076] [PATCH 0/1] " jgart via Guix-patches via
2023-05-22  7:28   ` Munyoki Kilyungi
2023-05-24 18:07   ` Arun Isaac
2024-06-29  6:55     ` jgart via Guix-patches via

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=86r1eff8cb.fsf@bonfacemunyoki.com \
    --to=me@bonfacemunyoki.com \
    --cc=50076@debbugs.gnu.org \
    --cc=arunisaac@systemreboot.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).