From: "Charles A. Roelli" <charles@aurox.ch>
To: Dmitry Gutov <dgutov@yandex.ru>, Eli Zaretskii <eliz@gnu.org>
Cc: 27230@debbugs.gnu.org
Subject: bug#27230: eldoc doc
Date: Tue, 27 Jun 2017 21:51:44 +0200 [thread overview]
Message-ID: <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> (raw)
In-Reply-To: <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru>
On 26/06/2017 03:04, Dmitry Gutov wrote:
> On 6/25/17 10:47 PM, Charles A. Roelli wrote:
>
>> FORMAT-STRING (or nil, if not given) is stored in
>> `eldoc-last-message'. If ARGS are given, FORMAT-STRING is first
>> formatted through `format-message'.
>
> I wonder if we ever call this function with more than one argument. If
> not, the code and the doc call for simplification. We can avoid
> advertising this possibility, at least.
I think it follows the tradition of other *-message functions, which
normally use the calling convention of `message'/`format-message'.
>
>> If `eldoc-last-message' is non-nil, display it using
>> `eldoc-message-function'. If it is nil, clear the echo area if
>> there was recently a message from ElDoc there.
>
> I think this needlessly prioritizes the implementation over the
> intention. And the latter is to display whatever the documentation
> function returns (if non-nil). Saving to eldoc-last-message is
> secondary, and can be mentioned later.
Agreed. Can you suggest how to word it? Here's what I come up with:
"Display FORMAT-STRING formatted with ARGS as an ElDoc message.
Store the message (if any) in `eldoc-last-message', and return it."
>
>> Return `eldoc-last-message'."
>
> This is probably non-essential, and we can avoid mentioning it.
I think it once again follows the convention of other *-message
functions, probably for consistency.
next prev parent reply other threads:[~2017-06-27 19:51 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-06-04 10:38 bug#27230: eldoc doc Charles A. Roelli
2017-06-05 22:08 ` Dmitry Gutov
2017-06-06 18:33 ` Charles A. Roelli
2017-06-06 20:19 ` Dmitry Gutov
2017-06-25 9:14 ` Charles A. Roelli
2017-06-25 14:26 ` Eli Zaretskii
2017-06-25 19:47 ` Charles A. Roelli
2017-06-26 1:04 ` Dmitry Gutov
2017-06-27 19:51 ` Charles A. Roelli [this message]
2017-06-27 23:50 ` Dmitry Gutov
2017-06-28 19:16 ` Charles A. Roelli
2017-07-22 8:11 ` Eli Zaretskii
2017-09-14 11:47 ` Peder O. Klingenberg
2017-09-14 12:02 ` Dmitry Gutov
2017-09-14 19:39 ` Charles A. Roelli
2017-09-14 22:03 ` Dmitry Gutov
2017-09-19 20:02 ` Charles A. Roelli
2017-09-20 18:12 ` Charles A. Roelli
2017-09-21 14:23 ` Dmitry Gutov
2017-09-21 18:33 ` Charles A. Roelli
2017-09-21 23:05 ` Dmitry Gutov
2017-09-25 23:26 ` Dmitry Gutov
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch \
--to=charles@aurox.ch \
--cc=27230@debbugs.gnu.org \
--cc=dgutov@yandex.ru \
--cc=eliz@gnu.org \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.