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

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


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

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

  reply	other threads:[~2021-08-23 20:54 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 [this message]
2021-08-27 11:14     ` Bonface Munyoki K.
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=87tujfrihc.fsf@systemreboot.net \
    --to=arunisaac@systemreboot.net \
    --cc=50076@debbugs.gnu.org \
    --cc=me@bonfacemunyoki.com \
    /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).