GNU bug report logs - #41181
adds emacs-interleave

Previous Next

Full log

View this message in rfc822 format

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: 41181 <at> debbugs.gnu.org
Cc: rdes <at> protonmail.com
Subject: [bug#41181] adds emacs-interleave
Date: Mon, 11 May 2020 09:10:25 +0200

Hello,

rdes via Guix-patches via <guix-patches <at> gnu.org> writes:

> The attached patch adds the emacs-interleave package.

Thank you! Some comments follow.

> Subject: [PATCH] gnu: Add emacs-interleave

Your commit message should conform to Guix rules. Here, you need to add

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

> +(define-public emacs-interleave
> +(package

Indentation seems wrong.

> +  (name "emacs-interleave")
> +  (version "20191129.958")
> +  (source
> +    (origin
> +      (method url-fetch)
> +      (uri (string-append
> +             "https://melpa.org/packages/interleave-"
> +             version
> +             ".el"))

We do not use MELPA sources. Instead, you could use `git-fetch' and
extract the latest stable release from here:

  https://github.com/rudolfochrist/interleave/releases

> +      (sha256
> +        (base32
> +          "0y183ggfmkjjywbcqgyinmr21hsg2vaw4d52bg1gsxbp673za2m8"))))

Nitpick: could you move the string on the same line as `base32'?

> +  (build-system emacs-build-system)
> +  (home-page
> +    "https://github.com/rudolfochrist/interleave")

Ditto. Could you move the string on the line above?

> +  (synopsis "Interleaving text books since 2015")

I think this synopsis needs to be reworded. As it is, it may not be
useful.

> +  (description
> +    "Interleave presents your PDF side by side to an [[http://orgmode.org][Org Mode]]

Description uses Texinfo syntax, not Org syntax. In this case, however,
I think "side by side to an Org buffer" is sufficient.

> +buffer with your notes, narrowing down to just those passages that are relevant to
> +the particular page in the document viewer.
> +")

You don't need to end the description with a final newline. It would be
nice to expound it a bit. For example, it could be interesting to know
this is a minor mode.

Don't forget to add a copyright line with your name at the top of the file.

Could you send an updated patch?

Regards,

-- 
Nicolas Goaziou

Previous Next

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