Hello,
I'm attaching a minor patch for documentation.
Regards,
Nikolaos Chatzikonstantinou
From ae0cb62a7400a5e45206663c22df6920f7f798f0 Mon Sep 17 00:00:00 2001
From: Nikolaos Chatzikonstantinou <nchatz...@gmail.com>
Date: Mon, 29 Apr 2024 08:38:33 -0400
Subject: [PATCH] doc: add example for module texinfo doc format
---
doc/ref/texinfo.texi | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/doc/ref/texinfo.texi b/doc/ref/texinfo.texi
index 64a866b23..45ecb6d68 100644
--- a/doc/ref/texinfo.texi
+++ b/doc/ref/texinfo.texi
@@ -472,11 +472,23 @@ Serialize the stexi @var{tree} into plain texinfo.
@node texinfo reflection
@subsection (texinfo reflection)
@subsubsection Overview
-Routines to generare @code{stexi} documentation for objects and modules.
+Routines to generate @code{stexi} documentation for objects and modules.
Note that in this context, an @dfn{object} is just a value associated
with a location. It has nothing to do with GOOPS.
+The convention for documenting Guile code is to include a
+three-semicolon comment block such as
+
+@example
+;;; Commentary:
+;;; <Module documentation>
+;;; Code:
+@end example
+
+where the documentation of a module is included in texinfo format in
+@code{<Module documentation>} and Guile code follows after@code{Code:}.
+
@subsubsection Usage
@anchor{texinfo reflection module-stexi-documentation}@defun module-stexi-documentation sym-name [%docs-resolver] [#:docs-resolver]
Return documentation for the module named @var{sym-name}. The
--
2.39.2
