GNU bug report logs - #57561
Improve documentation of seq-position

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 57561 in the body.
You can then email your comments to 57561 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: bug-gnu-emacs <at> gnu.org
Subject: Improve documentation of seq-position
Date: Sat, 03 Sep 2022 15:00:38 +0200

[Message part 1 (text/plain, inline)]

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

[0001-Improve-documentation-of-seq-position.patch (text/patch, attachment)]

Message #8 received at 57561 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: 57561 <at> debbugs.gnu.org
Subject: Re: bug#57561: Improve documentation of seq-position
Date: Sat, 03 Sep 2022 15:30:40 +0200

Damien Cassou <damien <at> cassou.me> writes:

> -  "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.

This makes the first line too long.

Message #11 received at 57561 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: damien <at> cassou.me, 57561 <at> debbugs.gnu.org
Subject: Re: bug#57561: Improve documentation of seq-position
Date: Sat, 03 Sep 2022 17:23:58 +0300

> Cc: 57561 <at> debbugs.gnu.org
> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Sat, 03 Sep 2022 15:30:40 +0200
> 
> Damien Cassou <damien <at> cassou.me> writes:
> 
> > -  "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.
> 
> This makes the first line too long.

Yes.  The usual fix would be

  Return the (zero-based) index of the first element in SEQUENCE equal to ELT.

Message #14 received at 57561 <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57561 <at> debbugs.gnu.org
Subject: Re: bug#57561: Improve documentation of seq-position
Date: Sat, 03 Sep 2022 18:52:54 +0200

[Message part 1 (text/plain, inline)]

Lars Ingebrigtsen <larsi <at> gnus.org> writes:
> Damien Cassou <damien <at> cassou.me> writes:
>> -  "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.
>
> This makes the first line too long.

Indeed. I applied the change suggested by Eli. Also, the same sentence
appeared several times in the file so the patch changes them all.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-Improve-documentation-of-seq-position.patch (text/x-patch, attachment)]

Message #17 received at 57561 <at> debbugs.gnu.org (full text, mbox):

From: Damien Cassou <damien <at> cassou.me>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 57561 <at> debbugs.gnu.org
Subject: Re: bug#57561: Improve documentation of seq-position
Date: Sat, 03 Sep 2022 18:56:30 +0200

[Message part 1 (text/plain, inline)]

Damien Cassou <damien <at> cassou.me> writes:
> Indeed. I applied the change suggested by Eli. Also, the same sentence
> appeared several times in the file so the patch changes them all.

Here is the correct patch (the comment was changed). I'm sorry for the
noise.

-- 
Damien Cassou

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[0001-Improve-documentation-of-several-functions-in-seq.el.patch (text/x-patch, attachment)]

Message #20 received at 57561 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: 57561 <at> debbugs.gnu.org
Subject: Re: bug#57561: Improve documentation of seq-position
Date: Sun, 04 Sep 2022 13:00:34 +0200

Damien Cassou <damien <at> cassou.me> writes:

> Here is the correct patch (the comment was changed). I'm sorry for the
> noise.

Thanks; pushed to Emacs 29.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.