* bug#64754: ‘generate-documentation’ shows evaluated default values
@ 2023-07-20 10:58 Ludovic Courtès
0 siblings, 0 replies; only message in thread
From: Ludovic Courtès @ 2023-07-20 10:58 UTC (permalink / raw)
To: 64754
The ‘generate-documentation’ procedure of (gnu services configuration)
shows evaluated default values, as in this example:
--8<---------------cut here---------------start------------->8---
scheme@(gnu services admin)> (define serialize-string identity)
scheme@(gnu services admin)> (define-configuration foo
(f (string (version)) "The version string."))
scheme@(gnu services admin)> (foo)
$44 = #<<foo> f: "3.0.99-git" %location: #f>
scheme@(gnu services admin)> (display (generate-documentation `((foo ,foo-fields)) 'foo))
@c %start of fragment
@deftp {Data Type} foo
Available @code{foo} fields are:
@table @asis
@item @code{f} (default: @code{"3.0.99-git"}) (type: string)
The version string.
@end table
@end deftp
@c %end of fragment
--8<---------------cut here---------------end--------------->8---
Notice that the ‘version’ call is expanded.
This is problematic because sometimes we explicitly want to have default
values like ‘%default-xyz’ or ‘(expt 2 10)’, and this is what we want
to appear in the manual, not their evaluation result.
Ludo’.
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2023-07-20 20:56 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-20 10:58 bug#64754: ‘generate-documentation’ shows evaluated default values Ludovic Courtès
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).