From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#19116: 25.0.50; doc string of `eval-expression' Date: Sat, 30 Apr 2016 20:22:52 +0300 Message-ID: <83lh3vnh8z.fsf@gnu.org> References: <589e7a71-0c91-4c28-b5d7-e0d61b405922@default> <87h9ejnmz6.fsf@gnus.org> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1462037082 20326 80.91.229.3 (30 Apr 2016 17:24:42 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 17:24:42 +0000 (UTC) Cc: larsi@gnus.org, 19116@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 19:24:30 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awYd3-0000T7-Pr for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 19:24:29 +0200 Original-Received: from localhost ([::1]:59092 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awYd0-0005YW-14 for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 13:24:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56609) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awYcq-0005Kb-LT for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:24:22 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awYcf-0000O2-1A for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:24:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:45896) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awYce-0000Mi-UL for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:24:04 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awYcb-0003Ma-J1 for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:24:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 17:24:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 19116 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: notabug Original-Received: via spool by 19116-submit@debbugs.gnu.org id=B19116.146203700212877 (code B ref 19116); Sat, 30 Apr 2016 17:24:01 +0000 Original-Received: (at 19116) by debbugs.gnu.org; 30 Apr 2016 17:23:22 +0000 Original-Received: from localhost ([127.0.0.1]:58233 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awYby-0003Lc-Hh for submit@debbugs.gnu.org; Sat, 30 Apr 2016 13:23:22 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:36636) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awYbw-0003LO-SM for 19116@debbugs.gnu.org; Sat, 30 Apr 2016 13:23:21 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awYbc-0008Hm-TG for 19116@debbugs.gnu.org; Sat, 30 Apr 2016 13:23:12 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:33308) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awYbc-0008EY-Py; Sat, 30 Apr 2016 13:23:00 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:1933 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1awYbW-0007jI-Ox; Sat, 30 Apr 2016 13:22:55 -0400 In-reply-to: (message from Drew Adams on Sat, 30 Apr 2016 09:04:12 -0800 (GMT-08:00)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:117396 Archived-At: > Date: Sat, 30 Apr 2016 09:04:12 -0800 (GMT-08:00) > From: Drew Adams > Cc: 19116@debbugs.gnu.org > > > > The doc string says only what this function does "When called > > > interactively". It says nothing about what it does when called from > > > Lisp. Please complete the description of the function, to take care of > > > this. > > > > This is how the doc starts: > > > > Evaluate EXP and print value in the echo area. > > When called interactively, read an Emacs Lisp expression and evaluate it. > > > > So I see no need to change anything here. > > Doc for commands should present the behavior first in terms > of interactive use - as a command, for all users. Which is what it does. > Only after that should it describe use of the command from > Lisp code. Which is what it does. > The first line of the doc string should not be the first line > of the doc string. You are contradicting yourself.