From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: "Charles A. Roelli" Newsgroups: gmane.emacs.bugs Subject: bug#27230: eldoc doc Date: Tue, 27 Jun 2017 21:51:44 +0200 Message-ID: <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit X-Trace: blaine.gmane.org 1498593133 8158 195.159.176.226 (27 Jun 2017 19:52:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 27 Jun 2017 19:52:13 +0000 (UTC) User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 Cc: 27230@debbugs.gnu.org To: Dmitry Gutov , Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jun 27 21:52:07 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPwWs-0001lf-UC for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Jun 2017 21:52:07 +0200 Original-Received: from localhost ([::1]:57961 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dPwWx-0000Mk-Ua for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Jun 2017 15:52:11 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:50834) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dPwWs-0000MT-Kp for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 15:52:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dPwWo-0000ky-MS for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 15:52:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:38513) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dPwWo-0000ku-Id for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 15:52:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dPwWo-0007Sn-BV for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 15:52:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Charles A. Roelli" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 27 Jun 2017 19:52:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 27230 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 27230-submit@debbugs.gnu.org id=B27230.149859311828676 (code B ref 27230); Tue, 27 Jun 2017 19:52:02 +0000 Original-Received: (at 27230) by debbugs.gnu.org; 27 Jun 2017 19:51:58 +0000 Original-Received: from localhost ([127.0.0.1]:41189 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPwWk-0007SR-1q for submit@debbugs.gnu.org; Tue, 27 Jun 2017 15:51:58 -0400 Original-Received: from sinyavsky.aurox.ch ([37.35.109.145]:51580) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dPwWi-0007SG-Jq for 27230@debbugs.gnu.org; Tue, 27 Jun 2017 15:51:57 -0400 Original-Received: from sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) by sinyavsky.aurox.ch (Postfix) with ESMTP id 0285922485 for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 19:46:53 +0000 (UTC) Authentication-Results: sinyavsky.aurox.ch (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=aurox.ch DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=aurox.ch; h= content-transfer-encoding:content-type:content-type:in-reply-to :mime-version:user-agent:date:date:message-id:from:from :references:to:subject:subject; s=dkim; t=1498592811; x= 1499456812; bh=wqcSKaikWDlIr+fgwaXMzLn015sFl2byPuVr+aC4jqU=; b=v V7GLjF4+1El0OCyo0t8N04+4vLPlWP9EgltW91y9Aw44wU+OZ3u8LRfwr+5EbN/k sltrUhC9ZU1ofFLIH5DZSaHANJHJeAA6eJ8f0xceavYkDvFRViUTYFSJEYIehi6/ Y72nkYxaVCSEassuhaF26aQ+CcV38FiY8mAfmYn0Xg= X-Virus-Scanned: Debian amavisd-new at test.virtualizor.com Original-Received: from sinyavsky.aurox.ch ([127.0.0.1]) by sinyavsky.aurox.ch (sinyavsky.aurox.ch [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id P8LSySK1AbJT for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 19:46:51 +0000 (UTC) Original-Received: from [192.168.1.120] (125.85.192.178.dynamic.wline.res.cust.swisscom.ch [178.192.85.125]) by sinyavsky.aurox.ch (Postfix) with ESMTPSA id 6484422443; Tue, 27 Jun 2017 19:46:47 +0000 (UTC) In-Reply-To: <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:133966 Archived-At: 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.