[bug#41181] adds emacs-interleave

[bug#41181] adds emacs-interleave

[rdes via Guix-patches via]

[-- Attachment #1.1: Type: text/plain, Size: 77 bytes --]

Hello,

The attached patch adds the emacs-interleave package.

Ryan Desfosses

[-- Attachment #1.2: Type: text/html, Size: 369 bytes --]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-Add-emacs-interleave.patch --]
[-- Type: text/x-patch; name="0001-gnu-Add-emacs-interleave.patch", Size: 1484 bytes --]

From 9dd929fc4ed069eee08e18efc0557a3bec27bd41 Mon Sep 17 00:00:00 2001
From: Ryan Desfosses <ryan@desfo.org>
Date: Sun, 10 May 2020 15:13:27 -0400
Subject: [PATCH] gnu: Add emacs-interleave

---
 gnu/packages/emacs-xyz.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index ce1b1c4b28..f09aedf43e 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -2184,6 +2184,31 @@ This buffer is typically shown as a sidebar (Emacs vertically splits the
 window).")
     (license license:gpl3+)))
 
+(define-public emacs-interleave
+(package
+  (name "emacs-interleave")
+  (version "20191129.958")
+  (source
+    (origin
+      (method url-fetch)
+      (uri (string-append
+             "https://melpa.org/packages/interleave-"
+             version
+             ".el"))
+      (sha256
+        (base32
+          "0y183ggfmkjjywbcqgyinmr21hsg2vaw4d52bg1gsxbp673za2m8"))))
+  (build-system emacs-build-system)
+  (home-page
+    "https://github.com/rudolfochrist/interleave")
+  (synopsis "Interleaving text books since 2015")
+  (description
+    "Interleave presents your PDF side by side to an [[http://orgmode.org][Org Mode]]
+buffer with your notes, narrowing down to just those passages that are relevant to
+the particular page in the document viewer.
+")
+  (license license:gpl3+)))
+
 (define-public emacs-mmm-mode
   (package
     (name "emacs-mmm-mode")
-- 
2.26.2

[bug#41181] adds emacs-interleave

[Nicolas Goaziou]

Hello,

rdes via Guix-patches via <guix-patches@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

[bug#41181] adds emacs-interleave

[rdes via Guix-patches via]

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

Hello Nicolas,

Thanks for the pointers.  Attached is an updated patch.

Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Monday, May 11, 2020 3:10 AM, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:

> Hello,
>
> rdes via Guix-patches via guix-patches@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



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch --]
[-- Type: text/x-patch; name="0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch", Size: 1580 bytes --]

From 28d87ed5f3d7372a759475b28bc9993560953d2d Mon Sep 17 00:00:00 2001
From: Ryan Desfosses <ryan@desfo.org>
Date: Fri, 15 May 2020 16:53:02 -0400
Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
 variable.

---
 gnu/packages/emacs-xyz.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 45ccced99e..b70b9fffb8 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -6052,6 +6052,31 @@ the Hydra very seamless; it's like a minor mode that disables itself
 automatically.")
     (license license:gpl3+)))
 
+(define-public emacs-interleave
+  (package
+    (name "emacs-interleave")
+    (version "1.4.0")
+    (source
+     (origin
+       (method git-fetch)
+       (uri
+        (git-reference
+         (url "https://github.com/rudolfochrist/interleave")
+         (commit (string-append "interleave-" version))))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32
+         "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))
+    (build-system emacs-build-system)
+    (home-page
+     "https://github.com/rudolfochrist/interleave")
+    (synopsis
+     "A minor mode that presents a document buffer next to an orgmode buffer")
+    (description
+     "Interleave is a minor mode that presents a document viewer side
+by side to an orgmode buffer with your notes relevant to the current page.")
+    (license license:gpl3+)))
+
 (define-public emacs-ivy
   (package
     (name "emacs-ivy")
-- 
2.26.2

[bug#41181] adds emacs-interleave

[rdes via Guix-patches via]

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

Hello,

Attached is the copyright line that should have been in the previous patch.

Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Friday, May 15, 2020 4:56 PM, rdes <rdes@protonmail.com> wrote:

> Hello Nicolas,
>
> Thanks for the pointers. Attached is an updated patch.
>
> Ryan
>
> Sent with ProtonMail Secure Email.
>
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
> On Monday, May 11, 2020 3:10 AM, Nicolas Goaziou mail@nicolasgoaziou.fr wrote:
>
> > Hello,
> > rdes via Guix-patches via guix-patches@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



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-packages-emacs-xyz.scm-Add-copyright.patch --]
[-- Type: text/x-patch; name="0001-gnu-packages-emacs-xyz.scm-Add-copyright.patch", Size: 785 bytes --]

From 7cc8535fb92e5d39276ec5cdd5bc078d3d8c55b6 Mon Sep 17 00:00:00 2001
From: Ryan Desfosses <ryan@desfo.org>
Date: Sun, 17 May 2020 09:15:46 -0400
Subject: [PATCH] * gnu/packages/emacs-xyz.scm: Add copyright.

---
 gnu/packages/emacs-xyz.scm | 1 +
 1 file changed, 1 insertion(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index b70b9fffb8..5d0beeb2d9 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -70,6 +70,7 @@
 ;;; Copyright © 2020 Alberto Eleuterio Flores Guerrero <barbanegra+guix@posteo.mx>
 ;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
 ;;; Copyright © 2020 pinoaffe <pinoaffe@airmail.cc>
+;;; Copyright © 2020 Ryan Desfosses <rdes@protonmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
-- 
2.26.2

[bug#41181] adds emacs-interleave

[Nicolas Goaziou]

Hello,

rdes <rdes@protonmail.com> writes:

> Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
>  variable.

Thank you for the updated patch. Some comments follow.

> +(define-public emacs-interleave
> +  (package
> +    (name "emacs-interleave")
> +    (version "1.4.0")
> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri
> +        (git-reference
> +         (url "https://github.com/rudolfochrist/interleave")
> +         (commit (string-append "interleave-" version))))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))

Could you move the hash on the line above?

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

Could you move the URI on the line above, too?

> +    (synopsis
> +     "A minor mode that presents a document buffer next to an orgmode buffer")

A synopsis does not start with "A". You may want to use "guix lint" to
spot this. 

You might use the summary from the home page:

  (synopsis "Emacs minor mode to interleave notes and text books")

> +    (description
> +     "Interleave is a minor mode that presents a document viewer side
> +by side to an orgmode buffer with your notes relevant to the current
> page.")

"orgmode buffer" -> "an Org buffer"

Could you send an updated patch and merge this with the copyright line
you sent?

Regards,

-- 
Nicolas Goaziou

[bug#41181] adds emacs-interleave

[rdes via Guix-patches via]

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

Hello Nicolas,

Thanks for the insight.  Attached is a patch with the suggestions from the previous email.

-Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Sunday, May 17, 2020 7:00 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:

&gt; Hello,
&gt;
&gt; rdes rdes@protonmail.com writes:
&gt;
&gt; &gt; Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
&gt; &gt; variable.
&gt;
&gt; Thank you for the updated patch. Some comments follow.
&gt;
&gt; &gt; +(define-public emacs-interleave
&gt; &gt;
&gt; &gt; -   (package
&gt; &gt; -   (name "emacs-interleave")
&gt; &gt; -   (version "1.4.0")
&gt; &gt; -   (source
&gt; &gt; -       (origin
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (method git-fetch)
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (uri
&gt; &gt;
&gt; &gt;
&gt; &gt; -          (git-reference
&gt; &gt;
&gt; &gt;
&gt; &gt; -           (url "https://github.com/rudolfochrist/interleave")
&gt; &gt;
&gt; &gt;
&gt; &gt; -           (commit (string-append "interleave-" version))))
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (file-name (git-file-name name version))
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (sha256
&gt; &gt;
&gt; &gt;
&gt; &gt; -          (base32
&gt; &gt;
&gt; &gt;
&gt; &gt; -           "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))
&gt; &gt;
&gt; &gt;
&gt;
&gt; Could you move the hash on the line above?
&gt;
&gt; &gt; -   (build-system emacs-build-system)
&gt; &gt; -   (home-page
&gt; &gt; -       "https://github.com/rudolfochrist/interleave")
&gt; &gt;
&gt; &gt;
&gt;
&gt; Could you move the URI on the line above, too?
&gt;
&gt; &gt; -   (synopsis
&gt; &gt; -       "A minor mode that presents a document buffer next to an orgmode buffer")
&gt; &gt;
&gt; &gt;
&gt;
&gt; A synopsis does not start with "A". You may want to use "guix lint" to
&gt; spot this.
&gt;
&gt; You might use the summary from the home page:
&gt;
&gt; (synopsis "Emacs minor mode to interleave notes and text books")
&gt;
&gt; &gt; -   (description
&gt; &gt; -       "Interleave is a minor mode that presents a document viewer side
&gt; &gt;
&gt; &gt;
&gt; &gt;
&gt; &gt; +by side to an orgmode buffer with your notes relevant to the current
&gt; &gt; page.")
&gt;
&gt; "orgmode buffer" -&gt; "an Org buffer"
&gt;
&gt; Could you send an updated patch and merge this with the copyright line
&gt; you sent?
&gt;
&gt; Regards,
&gt;
&gt; ---------------------------------------------------------------------------------------------
&gt;
&gt; Nicolas Goaziou

</mail@nicolasgoaziou.fr>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch --]
[-- Type: text/x-patch; name="0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch", Size: 1899 bytes --]

From 8997cb28bc694b0a614d691db592ccfc1f85b790 Mon Sep 17 00:00:00 2001
From: Ryan Desfosses <ryan@desfo.org>
Date: Fri, 15 May 2020 16:53:02 -0400
Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
 variable.

* gnu/packages/emacs-xyz.scm: Add copyright.
---
 gnu/packages/emacs-xyz.scm | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 45ccced99e..1a25547508 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -70,6 +70,7 @@
 ;;; Copyright © 2020 Alberto Eleuterio Flores Guerrero <barbanegra+guix@posteo.mx>
 ;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
 ;;; Copyright © 2020 pinoaffe <pinoaffe@airmail.cc>
+;;; Copyright © 2020 Ryan Desfosses <rdes@protonmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -6052,6 +6053,28 @@ the Hydra very seamless; it's like a minor mode that disables itself
 automatically.")
     (license license:gpl3+)))
 
+(define-public emacs-interleave
+  (package
+    (name "emacs-interleave")
+    (version "1.4.0")
+    (source
+     (origin
+       (method git-fetch)
+       (uri
+        (git-reference
+         (url "https://github.com/rudolfochrist/interleave")
+         (commit (string-append "interleave-" version))))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))
+    (build-system emacs-build-system)
+    (home-page "https://github.com/rudolfochrist/interleave")
+    (synopsis "Emacs minor mode to interleave notes and text books")
+    (description
+     "Interleave is a minor mode that presents a document viewer side
+by side to an Org buffer with your notes relevant to the current page.")
+    (license license:gpl3+)))
+
 (define-public emacs-ivy
   (package
     (name "emacs-ivy")
-- 
2.26.2

[bug#41181] adds emacs-interleave

[Nicolas Goaziou]

Hello,

rdes <rdes@protonmail.com> writes:

> From: Ryan Desfosses <ryan@desfo.org>
> Date: Fri, 15 May 2020 16:53:02 -0400
> Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
>  variable.

I fixed the commit message and applied your patch. Thank you.

Regards,

-- 
Nicolas Goaziou