Subject: bug#59186: closed (Re: [bug#59186] [PATCH v2] gnu: Add emacs-free-keys.)

From: [email-masked] (GNU bug Tracking System)
Date: Sat, 12 Nov 2022 10:48:02 +0000

Your bug report

#59186: [PATCH] gnu: Add emacs-free-keys.

which was filed against the guix-patches package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
59186: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=59186
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: [bug#59186] [PATCH v2] gnu: Add emacs-free-keys.
From: Nicolas Goaziou <[email-masked]>
To: jgart via Guix-patches via <[email-masked]>
Cc: [email-masked], jgart <[email-masked]>
Date: Sat, 12 Nov 2022 11:46:52 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

Hello,

jgart via Guix-patches via <[email-masked]> writes:

> * gnu/packages/emacs-xyz.scm (emacs-free-keys): New variable.
>
> Sorry about that. Here is v2 with the texinfo markup updated.

Thank you. I moved the package definition outside the end of the file,
changed @code{free-keys} into Free-keys (sorry, I couldn't help) and
applied it.

> Is what you're saying that @code markup should never be used to reference
> guix code?

No, it isn't.

I'm saying that we should not mix the Guix variable name (here
`emacs-free-keys') and the name of the project (here `free-keys'). The
description is more about the project than the Guix variable. Therefore,
we should reference the former, not the latter. As a consequence,
@code{free-keys} is better than @code{emacs-free-keys} because we're not
referencing Guix code.

Also, on a more personal POV, I think we're using emphasis too much in
descriptions as it hinders readability. In particular, @code markup
should really be reserved to symbols (variables, functions…) rather than
project names. Capitalization is much more elegant in this case.

Regards,
-- 
Nicolas Goaziou

Subject: [PATCH] gnu: Add emacs-free-keys.
From: jgart <[email-masked]>
To: [email-masked]
Cc: jgart <[email-masked]>
Date: Thu, 10 Nov 2022 17:15:38 -0600
List-Id: <debbugs-submit.debbugs.gnu.org>

* gnu/packages/emacs-xyz.scm (emacs-free-keys): New variable.
---
 gnu/packages/emacs-xyz.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index c0faf221d6..aaa6e7d0e4 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -33866,6 +33866,28 @@ (define-public emacs-vertico-posframe
 a vertical completion UI.")
     (license license:gpl3+)))
 
+(define-public emacs-free-keys
+  (package
+    (name "emacs-free-keys")
+    (version "1.0.0")
+    (source
+     (origin
+       (method git-fetch)
+       (uri
+        (git-reference
+         (url "https://github.com/Fuco1/free-keys")
+         (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "0xgifa7s9n882f9ymyyz9gc11xfbj3vfpnxiq1fqfm5hmwx9pwbc"))))
+    (build-system emacs-build-system)
+    (home-page "https://github.com/Fuco1/free-keys")
+    (synopsis "Show free keybindings for modkeys or prefixes")
+    (description
+"@code{emacs-free-keys} shows available key bindings in the current
+buffer.")
+    (license license:gpl3+)))
+
 ;;;
 ;;; Avoid adding new packages to the end of this file. To reduce the chances
 ;;; of a merge conflict, place them above by existing packages with similar
-- 
2.38.1