unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: "Pierre-Henry Fröhring" <contact@phfrohring.com>
Cc: 53673@debbugs.gnu.org
Subject: [bug#53673] [PATCH] Add package: emacs-beacon-1.3.4
Date: Sun, 06 Feb 2022 21:39:51 +0100	[thread overview]
Message-ID: <87pmnzhgq0.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <20220131225040.268586-1-contact@phfrohring.com> ("Pierre-Henry Fröhring"'s message of "Mon, 31 Jan 2022 23:50:41 +0100")

Hello,

Pierre-Henry Fröhring <contact@phfrohring.com> writes:

> ---
> +(define-public emacs-beacon-1.3.4

Thank you. Some comments follow.

First, the variable should not include the version string. So, you
should write:

  (define-public emacs-beacon

Then, you need to provide a proper commit message. Such messages are
somewhat standardized in Guix. Here, this could be:

    gnu: Add emacs-beacon.

    * gnu/packages/emacs-xyz.scm (emacs-beacon): New variable.

> +  (package
> +    (name "emacs-beacon")
> +    (version "1.3.4")
> +    (source (origin
> +              (method url-fetch)
> +              (uri (string-append "https://github.com/Malabarba/"
> +                                  (second (string-split name #\-))
> +                                  "/archive/refs/tags/" version ".tar.gz"))

This URL is not stable. Use git-fetch method, with version string as the tag.

> +    (synopsis "A light that follows your cursor around so you don't lose it!")

A synopsis may not start with an article. I suggest to use "guix lint"
on your package definition. I suggest:

  Emacs minor mode creating a light that follows your cursor around

> +    (description
> +     "This is a global minor-mode. Turn it on everywhere with: (beacon-mode 1).
> +Whenever the window scrolls a light will shine on top of your cursor so you know where it is.
> +That’s it.")

The part about "(beacon-mode 1)" belongs to the manual, not the
description. The last sentence can be dropped, too. Also, sentences
should be separated with two spaces in descriptions. I suggest:

Beacon is an Emacs minor-mode.  Whenever the ... where it is.


Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou




  reply	other threads:[~2022-02-06 20:41 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-31 22:50 [bug#53673] [PATCH] Add package: emacs-beacon-1.3.4 Pierre-Henry Fröhring
2022-02-06 20:39 ` Nicolas Goaziou [this message]
2022-02-06 22:26   ` Pierre-Henry Fröhring
2022-02-06 22:25 ` [bug#53673] [PATCH] gnu: Add emacs-beacon Pierre-Henry Fröhring
2022-02-06 22:52   ` bug#53673: " Nicolas Goaziou

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=87pmnzhgq0.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=53673@debbugs.gnu.org \
    --cc=contact@phfrohring.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).