From: "Ludovic Courtès" <ludo@gnu.org>
To: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Cc: 53439@debbugs.gnu.org
Subject: [bug#53439] [PATCH] doc: Document search paths.
Date: Tue, 25 Jan 2022 14:06:47 +0100 [thread overview]
Message-ID: <87a6fknevs.fsf@gnu.org> (raw)
In-Reply-To: <87r18w6dxx.fsf@gmail.com> (Maxim Cournoyer's message of "Mon, 24 Jan 2022 16:06:50 -0500")
Hello,
Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis:
> Ludovic Courtès <ludo@gnu.org> writes:
[...]
>> “When true” is to be taken literally: if it has truth value, in the
>> Scheme sense. But “Unless @code{#f}” might be clearer?
>>
>> (“Optional” sounds confusing to me because there has to be a value,
>> default or not.)
>
> From the user point of view, specifying it is really optional though.
Yes, that’s what the “(default: @code{#f})” bit conveys.
> Yours is more correct but perhaps confusing to those not knowing a
> string is truthy in Guile (and I'd argue it takes attention away from
> what is important here).
>
> What I had on mind was:
>
> "An optional regular expression to specify which files should be
> matched, based on their base name." or similar.
>
> (optional because if you don't specify it defaults to #f, which means
> "no added behavior").
>
> I've used that approach when describing optional fields of service
> configurations in the past.
OK. The way I see it, that it’s optional is already implied by the fact
it has a default value.
Regarding the truth value, I ended up in
a00dff3ac113722a709dbe97a727777b3739a5c1 with hopefully clearer wording:
@item @code{file-pattern} (default: @code{#f})
This must be either @code{#f} or a regular expression specifying
files to be matched @emph{within} the sub-directories specified by the
@code{files} field.
I guess we’re nitpicking :-) but I like to have, on one hand, text in
natural language with examples that conveys ideas in an informal way,
and on the other hand, reference material (@deftp, @deffn, etc.) that’s
rigorous.
Ludo’.
next prev parent reply other threads:[~2022-01-25 15:01 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-22 10:47 [bug#53439] [PATCH] doc: Document search paths Ludovic Courtès
2022-01-22 12:49 ` Maxime Devos
2022-01-22 15:54 ` Ludovic Courtès
2022-01-22 12:54 ` Maxime Devos
2022-01-22 13:00 ` Maxime Devos
2022-01-23 3:00 ` Maxim Cournoyer
2022-01-23 21:40 ` Ludovic Courtès
2022-01-23 22:41 ` bug#53439: " Ludovic Courtès
2022-01-24 21:06 ` [bug#53439] " Maxim Cournoyer
2022-01-25 13:06 ` Ludovic Courtès [this message]
2022-01-26 1:50 ` Maxim Cournoyer
[not found] ` <handler.53439.D53439.164297769417402.notifdone@debbugs.gnu.org>
2022-01-24 9:41 ` Ludovic Courtès
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=87a6fknevs.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=53439@debbugs.gnu.org \
--cc=maxim.cournoyer@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.