all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Rostislav Svoboda <rostislav.svoboda@gmail.com>
Cc: 62122@debbugs.gnu.org
Subject: [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc.
Date: Fri, 17 Mar 2023 09:36:52 +0100	[thread overview]
Message-ID: <87cz57dba3.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <20230311144938.765-1-Rostislav.Svoboda@gmail.com> (Rostislav Svoboda's message of "Sat, 11 Mar 2023 15:49:35 +0100")

Hello,

Rostislav Svoboda <rostislav.svoboda@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




  parent reply	other threads:[~2023-03-17  8:38 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-11 14:49 [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc Rostislav Svoboda
2023-03-11 14:49 ` [bug#62121] [PATCH 2/4] gnu: Add emacs-railscasts-theme Rostislav Svoboda
2023-03-17  8:43   ` bug#62121: " Nicolas Goaziou
2023-03-27 19:17     ` [bug#62121] " Rostislav Svoboda
2023-03-30 10:39       ` Nicolas Goaziou
2023-03-11 14:49 ` [bug#62123] [PATCH 3/4] gnu: Add emacs-pippel Rostislav Svoboda
2023-03-13 13:01   ` Rostislav Svoboda
2023-03-17  8:51     ` Nicolas Goaziou
2023-03-28 22:34       ` Rostislav Svoboda
2023-03-30 10:38         ` bug#62123: " Nicolas Goaziou
2023-03-11 14:49 ` [bug#62124] [PATCH 4/4] gnu: Add emacs-column-enforce-mode Rostislav Svoboda
2023-03-24  9:15   ` bug#62124: " Nicolas Goaziou
2023-03-17  8:36 ` Nicolas Goaziou [this message]
2023-03-27 19:17   ` [bug#62122] [PATCH 1/4] gnu: Add emacs-sphinx-doc Rostislav Svoboda
2023-03-30 16:21     ` bug#62122: " Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87cz57dba3.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=62122@debbugs.gnu.org \
    --cc=rostislav.svoboda@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.