From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Iwan in 't Groen <iwanintgroen@gmail.com>
Cc: 42871@debbugs.gnu.org
Subject: bug#42871: 28.0.50; Documentation for `seq-contains-p` is outdated
Date: Wed, 19 Aug 2020 11:56:45 +0100 [thread overview]
Message-ID: <87a6yqx5si.fsf@tcd.ie> (raw)
In-Reply-To: <CD4AE701-FE5D-44D8-86E9-E12BD21015BF@gmail.com> (Iwan in 't Groen's message of "Wed, 19 Aug 2020 10:14:28 +0200")
Iwan in 't Groen <iwanintgroen@gmail.com> writes:
> The return value in the description of this function (now a predicate) should also be changed.
>
> Currently is says:
> This function returns non-‘nil’ if at least one element in SEQUENCE is equal to ELT.
>
> It should be:
> This function returns ’t’ if at least one element in SEQUENCE is equal to ELT.
>
> diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi
> index ca52369bd0..bb80307c8c 100644
> --- a/doc/lispref/sequences.texi
> +++ b/doc/lispref/sequences.texi
> @@ -784,7 +784,7 @@ Sequence Functions
>
>
> @defun seq-contains-p sequence elt &optional function
> - This function returns non-@code{nil} if at least one element in
> + This function returns @code{t} if at least one element in
> @var{sequence} is equal to @var{elt}. If the optional argument
> @var{function} is non-@code{nil}, it is a function of two arguments to
> use instead of the default @code{equal}.
I don't feel strongly about this, but note that in general it's common
and fine to say non-nil in place of t, even when the value is t.
Predicates are allowed to return other non-nil values too, see
e.g. proper-list-p. The only time the distinction matters enough to
document it is when different non-nil values have different meanings,
e.g. with while-no-input or with certain user options.
HTH,
--
Basil
next prev parent reply other threads:[~2020-08-19 10:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-15 14:04 bug#42871: 28.0.50; Documentation for `seq-contains-p` is outdated Iwan in 't Groen
2020-08-15 15:17 ` Eli Zaretskii
2020-08-19 8:14 ` Iwan in 't Groen
2020-08-19 10:56 ` Basil L. Contovounesios [this message]
2020-08-19 14:35 ` Eli Zaretskii
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87a6yqx5si.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=42871@debbugs.gnu.org \
--cc=iwanintgroen@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 public inbox
https://git.savannah.gnu.org/cgit/emacs.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).