GNU bug report logs - #62122
[PATCH 1/4] gnu: Add emacs-sphinx-doc.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 62122 in the body.
You can then email your comments to 62122 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Rostislav Svoboda <rostislav.svoboda <at> gmail.com>
To: guix-patches <at> gnu.org
Cc: Rostislav Svoboda <Rostislav.Svoboda <at> gmail.com>
Subject: [PATCH 1/4] gnu: Add emacs-sphinx-doc.
Date: Sat, 11 Mar 2023 15:49:35 +0100

* gnu/packages/emacs-xyz.scm (emacs-sphinx-doc): New variable.
---
 gnu/packages/emacs-xyz.scm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 509c640b78..11afbe7778 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -12411,6 +12411,34 @@ (define-public emacs-spinner
 ongoing operations.")
     (license license:gpl3+)))
 
+(define-public emacs-sphinx-doc
+  (let ((commit "1eda612a44ef027e5229895daa77db99a21b8801"))
+    (package
+      (name "emacs-sphinx-doc")
+      (version "0.1.0")
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/naiquevin/sphinx-doc.el")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32
+           "0q72i95yx3xa57jlgr7dik6prf20hi8bp8xf3f5c6ificv7i5378"))))
+      (build-system emacs-build-system)
+      (propagated-inputs
+       (list emacs-dash emacs-s))
+      (home-page
+       "https://github.com/naiquevin/sphinx-doc.el")
+      (synopsis
+       "Generate Sphinx friendly docstrings for Python functions")
+      (description
+       "Emacs minor mode for inserting docstring skeleton for Python functions
+and methods.  The structure of the docstring is as per the requirement of the
+Sphinx documentation generator.")
+      (license license:expat))))
+
 (define-public emacs-sparql-mode
   (package
     (name "emacs-sparql-mode")
-- 
2.39.2

Message #8 received at 62122 <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: Rostislav Svoboda <rostislav.svoboda <at> gmail.com>
Cc: 62122 <at> debbugs.gnu.org
Subject: Re: [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc.
Date: Fri, 17 Mar 2023 09:36:52 +0100

Hello,

Rostislav Svoboda <rostislav.svoboda <at> gmail.com> writes:

> * gnu/packages/emacs-xyz.scm (emacs-sphinx-doc): New variable.

Thank you. Some comments follow.

> +(define-public emacs-sphinx-doc
> +  (let ((commit "1eda612a44ef027e5229895daa77db99a21b8801"))

Since you're using a non-tagged commit, you also need to bind revision
to "0" or "1". FWIW, I prefer latter because Repology thinks "version-0"
predates "version".

> +    (package
> +      (name "emacs-sphinx-doc")
> +      (version "0.1.0")

Base version is "0.3.0" according to Version keyword. Therefore, this should be

   (git-version "0.3.0" revision commit)

> +      (home-page
> +       "https://github.com/naiquevin/sphinx-doc.el")

You can use a single line here.

> +      (synopsis
> +       "Generate Sphinx friendly docstrings for Python functions")

Ditto. Maybe add "in Emacs" at the end?

> +      (description
> +       "Emacs minor mode for inserting docstring skeleton for Python functions
> +and methods.

This should be a full sentence.

  Sphinx Doc is an Emacs minor mode…

Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou

Message #11 received at 62122 <at> debbugs.gnu.org (full text, mbox):

From: Rostislav Svoboda <rostislav.svoboda <at> gmail.com>
To: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Cc: 62122 <at> debbugs.gnu.org
Subject: Re: [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc.
Date: Mon, 27 Mar 2023 21:17:37 +0200

Hello Nicolas,
I'm resending the patch.
Cheers Bost



From d7efd6fa74128809cc3f49ca9a8420369e96ad79 Mon Sep 17 00:00:00 2001
From: Rostislav Svoboda <Rostislav.Svoboda <at> gmail.com>
Date: Mon, 27 Mar 2023 20:58:51 +0200
Subject: [PATCH 1/2] gnu: Add emacs-sphinx-doc.

* gnu/packages/emacs-xyz.scm (emacs-sphinx-doc): New variable.
---
 gnu/packages/emacs-xyz.scm | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index da2856abc8..afc0726230 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -12487,6 +12487,32 @@ (define-public emacs-sparql-mode
 as Fuseki or DBPedia.")
     (license license:gpl3+)))

+(define-public emacs-sphinx-doc
+  (let ((commit "1eda612a44ef027e5229895daa77db99a21b8801")
+        (revision "1"))
+    (package
+      (name "emacs-sphinx-doc")
+      (version (git-version "0.3.0" revision commit))
+      (source (origin
+                (method git-fetch)
+                (uri (git-reference
+                      (url "https://github.com/naiquevin/sphinx-doc.el")
+                      (commit commit)))
+                (file-name (git-file-name name version))
+                (sha256
+                 (base32
+                  "0q72i95yx3xa57jlgr7dik6prf20hi8bp8xf3f5c6ificv7i5378"))))
+      (build-system emacs-build-system)
+      (propagated-inputs (list emacs-dash emacs-s))
+      (home-page "https://github.com/naiquevin/sphinx-doc.el")
+      (synopsis
+       "Generate Sphinx friendly docstrings for Python functions in Emacs")
+      (description
+       "Sphinx Doc is an Emacs minor mode for inserting docstring
skeleton for Python
+functions and methods.  The structure of the docstring is as per the
requirement of
+the Sphinx documentation generator.")
+      (license license:expat))))
+
 (define-public emacs-better-defaults
   (package
     (name "emacs-better-defaults")
-- 
2.39.2

Message #16 received at 62122-done <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: Rostislav Svoboda <rostislav.svoboda <at> gmail.com>
Cc: 62122-done <at> debbugs.gnu.org
Subject: Re: [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc.
Date: Thu, 30 Mar 2023 18:21:48 +0200

Hello,

Rostislav Svoboda <rostislav.svoboda <at> gmail.com> writes:

> Subject: [PATCH 1/2] gnu: Add emacs-sphinx-doc.
>
> * gnu/packages/emacs-xyz.scm (emacs-sphinx-doc): New variable.

Applied. Thank you.

Regards,
-- 
Nicolas Goaziou

Previous Next

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