Subject: Improve documentation of seq-position

From: Damien Cassou <[email-masked]>
Date: Sat, 03 Sep 2022 15:00:38 +0200

Tags: patch

Fix documentation of `seq-position' according to Eli Zaretskii's
recommendation.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill
>From 093cb247148a965e5cd80056eff38d3ef6f288bb Mon Sep 17 00:00:00 2001
From: Damien Cassou <[email-masked]>
Date: Sat, 3 Sep 2022 14:56:53 +0200
Subject: [PATCH] Improve documentation of seq-position

* doc/lispref/sequences.texi (Sequence Functions):
* lisp/emacs-lisp/seq.el (seq-position): Use more standard wording in
the documentation of `seq-position'.
---
 doc/lispref/sequences.texi | 2 +-
 lisp/emacs-lisp/seq.el     | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi
index 1f6f80521c..cc956952d6 100644
--- a/doc/lispref/sequences.texi
+++ b/doc/lispref/sequences.texi
@@ -863,7 +863,7 @@ Sequence Functions
 @end defun
 
 @defun seq-position sequence elt &optional function
-  This function returns the index of the first element in
+  This function returns the (zero-based) index of the first element in
 @var{sequence} that 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}.
diff --git a/lisp/emacs-lisp/seq.el b/lisp/emacs-lisp/seq.el
index b6f0f66e5b..a121256146 100644
--- a/lisp/emacs-lisp/seq.el
+++ b/lisp/emacs-lisp/seq.el
@@ -435,8 +435,8 @@ seq-set-equal-p
 
 ;;;###autoload
 (cl-defgeneric seq-position (sequence elt &optional testfn)
-  "Return the index of the first element in SEQUENCE that is equal to ELT.
-Equality is defined by TESTFN if non-nil or by `equal' if nil."
+  "Return the (zero-based) index of the first element in SEQUENCE that is equal to ELT.
+Equality is defined by the function TESTFN, which defaults to `equal'."
   (let ((index 0))
     (catch 'seq--break
       (seq-doseq (e sequence)
-- 
2.36.2