Subject: [PATCH] doc: package Reference: Mention syntax of package-description

From: Luis Felipe <[email-masked]>
Date: Fri, 08 Apr 2022 21:24:23 +0000

Hi,

Find the patch attached to this message.

Cheers,

---
Luis Felipe López Acevedo
https://luis-felipe.gitlab.io/

From e9719831cfd79e65c9091a628703338ea79dae98 Mon Sep 17 00:00:00 2001
From: Luis Felipe <[email-masked]>
Date: Fri, 8 Apr 2022 15:57:36 -0500
Subject: [PATCH] doc: package Reference: Mention syntax of
 package-description.

* doc/guix.texi (package Reference) <description>: Mention that the
string is in Texinfo syntax.
---
 doc/guix.texi | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 59db00e581..3fd1a6a044 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7362,7 +7362,8 @@ for details.
 A one-line description of the package.
 
 @item @code{description}
-A more elaborate description of the package.
+A more elaborate description of the package, as a string in Texinfo
+syntax.
 
 @item @code{license}
 @cindex license, of packages
-- 
2.34.0