From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.bugs Subject: bug#27230: eldoc doc Date: Wed, 28 Jun 2017 02:50:24 +0300 Message-ID: References: <282e174a-e9c0-6bec-32f5-ed9d772e5e1d@yandex.ru> <83efu8ta6n.fsf@gnu.org> <4107369a-5d50-7e46-2e81-57c4ef5c7965@yandex.ru> <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> 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 1498607485 31867 195.159.176.226 (27 Jun 2017 23:51:25 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 27 Jun 2017 23:51:25 +0000 (UTC) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Thunderbird/54.0 Cc: 27230@debbugs.gnu.org To: "Charles A. Roelli" , Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jun 28 01:51:19 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 1dQ0GJ-0007lt-8i for geb-bug-gnu-emacs@m.gmane.org; Wed, 28 Jun 2017 01:51:15 +0200 Original-Received: from localhost ([::1]:58616 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dQ0GL-00022o-1s for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Jun 2017 19:51:19 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43208) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dQ0GB-00022U-HY for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 19:51:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dQ0G6-0007cJ-Ii for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 19:51:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:38605) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dQ0G6-0007cA-F8 for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 19:51:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1dQ0G6-0004oR-59 for bug-gnu-emacs@gnu.org; Tue, 27 Jun 2017 19:51:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Dmitry Gutov Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 27 Jun 2017 23:51: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.149860743518457 (code B ref 27230); Tue, 27 Jun 2017 23:51:02 +0000 Original-Received: (at 27230) by debbugs.gnu.org; 27 Jun 2017 23:50:35 +0000 Original-Received: from localhost ([127.0.0.1]:41282 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQ0Ff-0004nd-4L for submit@debbugs.gnu.org; Tue, 27 Jun 2017 19:50:35 -0400 Original-Received: from mail-wm0-f47.google.com ([74.125.82.47]:38485) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dQ0Fd-0004nL-Ji for 27230@debbugs.gnu.org; Tue, 27 Jun 2017 19:50:33 -0400 Original-Received: by mail-wm0-f47.google.com with SMTP id b184so42015946wme.1 for <27230@debbugs.gnu.org>; Tue, 27 Jun 2017 16:50:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=9ev+wNdwpJHX/uMKvZ/oV4kJInlt/aq5m6YnA9YHooA=; b=CX8C1u2nCamtw9mM4kS2GIm4J2veTLqppOvsJjeubtVuWLr9e1oY2lHRVEAciI0zJN st+PTRXmf/W7LGwLFL2Z927xtK36iNXsAp+XX+GIgeEEIbLawCesiolXOxQVDSgWzTQp 5OuFAhaA5gW4p3IzMqomBnreXVYL/PWslzn5ek0GQpPRjEnOtMyRvtjV/TrqT9IyFZ+R phVLJhMl/dkNSiE98/03wAwEJFGAi6zOvMnO7GUaaPEA5qsta4hOxn1GdvP2Spfi1XXh obePSH3yEJk+guSTDy9hFWuKFDBMIYzQuwPGJZ6a+feZFmMgkXzUPE0n5YIo7tLlBGtH zTnw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=9ev+wNdwpJHX/uMKvZ/oV4kJInlt/aq5m6YnA9YHooA=; b=fDI0DT2ziSyXkmsc3LaUjFxAdNnQUT2DjuiE4eZHuELoWHeORKNcmYhO5CWTIo3wt7 so5lEj12iPuwwAkppiDNE4lyNWL7nkMyf8FIZ2e2MRZt+4atkvZwuKqs74YkUpiqqLQy JzxknZdguMGm9JLr+Qvk517rK8meJBD5SzrLD5g9B1Tr7nL+mADI/rgUM8Fk2o8PSI2X qA0Th3O3I9dOkKDy+TgqxRtKNd+caEs8Vsk+Wotz5+wgfHfq8F3QUHraQxXLTjSX7MiT 0oIGgOA5D6z4rtgVC0inofBy3orGA58xhs2tWGvtRHkba12tS+sibMmznZlrx1TyFF4r IW+g== X-Gm-Message-State: AKS2vOxwdT0bT/cuXVdhIebSE3KJldjyagta57RTY8xTLGrTTLIVRifs /gtQrxNK+Ml/BeQjOxQ= X-Received: by 10.28.18.201 with SMTP id 192mr5013332wms.2.1498607427523; Tue, 27 Jun 2017 16:50:27 -0700 (PDT) Original-Received: from [192.168.1.3] ([185.105.174.193]) by smtp.googlemail.com with ESMTPSA id t204sm4128187wme.2.2017.06.27.16.50.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 27 Jun 2017 16:50:26 -0700 (PDT) In-Reply-To: <989c1d30-2eb4-41d3-e7a3-228ce365a69c@aurox.ch> Content-Language: en-US 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:133970 Archived-At: On 6/27/17 10:51 PM, Charles A. Roelli wrote: > I think it follows the tradition of other *-message functions, which > normally use the calling convention of `message'/`format-message'. Do we really need a function in "the tradition of other *-message functions" if we don't ever use it like that? > 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." Looks okay to me, aside from what I mentioned above. >>> 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. Yeah, ok.