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

Previous Next

Full log

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

Previous Next

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