GNU bug report logs - #44991
27.1; Documentation mismatch for message-fetch-field

Previous Next

Full log

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Vladimir Nikishkin <lockywolf <at> gmail.com>
Cc: 44991 <at> debbugs.gnu.org
Subject: Re: bug#44991: 27.1; Documentation mismatch for message-fetch-field
Date: Wed, 02 Dec 2020 11:17:20 +0100

Vladimir Nikishkin <lockywolf <at> 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

Previous Next

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