From: Lars Ingebrigtsen <larsi@gnus.org>
To: Vladimir Nikishkin <lockywolf@gmail.com>
Cc: 44991@debbugs.gnu.org
Subject: bug#44991: 27.1; Documentation mismatch for message-fetch-field
Date: Wed, 02 Dec 2020 11:17:20 +0100 [thread overview]
Message-ID: <87eek84imn.fsf@gnus.org> (raw)
In-Reply-To: <878sahpu3a.fsf@delllaptop.lockywolf.net> (Vladimir Nikishkin's message of "Tue, 01 Dec 2020 20:51:53 +0800")
Vladimir Nikishkin <lockywolf@gmail.com> writes:
> Dear Emacs Developers,
>
> The docstring for `message-fetch-fiels' states:
> ```
> (message-fetch-field HEADER &optional NOT-ALL)
> The same as ‘mail-fetch-field’, only remove all newlines.
> ```
>
> The prototype is correct, but the documentation is wrong.
>
> Look at the prototype of `mail-fetch-field'.
> ```
> (mail-fetch-field FIELD-NAME &optional LAST ALL LIST DELETE)
> ```
>
> Firstly, the `message-fetch-field' cannot be used as a drop-in
> replacement for `mail-fetch-field' due to the difference in prototypes.
>
> Secondly, the ALL and NOT-ALL arguments are extremely easy to confuse.
I've now fixed the message-fetch-field doc string in Emacs 28 so that it
actually describes what it does. And renamed NOT-ALL to FIRST.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2020-12-02 10:17 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-01 12:51 bug#44991: 27.1; Documentation mismatch for message-fetch-field Vladimir Nikishkin
2020-12-02 10:17 ` Lars Ingebrigtsen [this message]
2020-12-02 15:09 ` Eli Zaretskii
2020-12-03 8:48 ` Lars Ingebrigtsen
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=87eek84imn.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=44991@debbugs.gnu.org \
--cc=lockywolf@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).