[PATCH 1/4] gnu: Add emacs-sphinx-doc.

  • Done
  • quality assurance status badge
Details
2 participants
  • Nicolas Goaziou
  • Rostislav Svoboda
Owner
unassigned
Submitted by
Rostislav Svoboda
Severity
normal
R
R
Rostislav Svoboda wrote on 11 Mar 2023 15:49
(address . guix-patches@gnu.org)(name . Rostislav Svoboda)(address . Rostislav.Svoboda@gmail.com)
20230311144938.765-1-Rostislav.Svoboda@gmail.com
* gnu/packages/emacs-xyz.scm (emacs-sphinx-doc): New variable.
---
gnu/packages/emacs-xyz.scm | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)

Toggle diff (41 lines)
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
N
N
Nicolas Goaziou wrote on 17 Mar 2023 09:36
(name . Rostislav Svoboda)(address . rostislav.svoboda@gmail.com)(address . 62122@debbugs.gnu.org)
87cz57dba3.fsf@nicolasgoaziou.fr
Hello,

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

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

Thank you. Some comments follow.

Toggle quote (3 lines)
> +(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".

Toggle quote (4 lines)
> + (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)

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

You can use a single line here.

Toggle quote (3 lines)
> + (synopsis
> + "Generate Sphinx friendly docstrings for Python functions")

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

Toggle quote (4 lines)
> + (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
R
R
Rostislav Svoboda wrote on 27 Mar 2023 21:17
(name . Nicolas Goaziou)(address . mail@nicolasgoaziou.fr)(address . 62122@debbugs.gnu.org)
CAEtmmezvPfv69HgXGQj2LsGyzo2+6p7FSDv74ULtxbmesO5pAQ@mail.gmail.com
Hello Nicolas,
I'm resending the patch.
Cheers Bost



From d7efd6fa74128809cc3f49ca9a8420369e96ad79 Mon Sep 17 00:00:00 2001
From: Rostislav Svoboda <Rostislav.Svoboda@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(+)

Toggle diff (41 lines)
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
N
N
Nicolas Goaziou wrote on 30 Mar 2023 18:21
(name . Rostislav Svoboda)(address . rostislav.svoboda@gmail.com)(address . 62122-done@debbugs.gnu.org)
87sfdmky5f.fsf@nicolasgoaziou.fr
Hello,

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

Toggle quote (4 lines)
> 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
Closed
?