From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#19116: 25.0.50; doc string of `eval-expression' Date: Sat, 30 Apr 2016 09:55:08 -0800 (GMT-08:00) Message-ID: References: <<589e7a71-0c91-4c28-b5d7-e0d61b405922@default> <87h9ejnmz6.fsf@gnus.org>> <> <<83lh3vnh8z.fsf@gnu.org>> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1462039003 16110 80.91.229.3 (30 Apr 2016 17:56:43 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 17:56:43 +0000 (UTC) Cc: larsi@gnus.org, 19116@debbugs.gnu.org To: Eli Zaretskii , Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 19:56: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 1awZ81-0005nj-UP for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 19:56:30 +0200 Original-Received: from localhost ([::1]:59165 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awZ7y-0004WR-6J for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 13:56:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35841) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awZ7p-0004Il-Fb for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:56:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awZ7d-0002WN-Qw for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:56:12 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:45924) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awZ7d-0002VC-NL for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:56:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awZ7a-0005lh-5h for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 13:56:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 17:56:02 +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.146203892122126 (code B ref 19116); Sat, 30 Apr 2016 17:56:02 +0000 Original-Received: (at 19116) by debbugs.gnu.org; 30 Apr 2016 17:55:21 +0000 Original-Received: from localhost ([127.0.0.1]:58261 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awZ6u-0005kn-QX for submit@debbugs.gnu.org; Sat, 30 Apr 2016 13:55:20 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:47308) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awZ6t-0005kd-D9 for 19116@debbugs.gnu.org; Sat, 30 Apr 2016 13:55:19 -0400 Original-Received: from aserv0021.oracle.com (aserv0021.oracle.com [141.146.126.233]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u3UHtCpN022288 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 30 Apr 2016 17:55:12 GMT Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by aserv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u3UHtCZ5026276 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Sat, 30 Apr 2016 17:55:12 GMT Original-Received: from abhmp0019.oracle.com (abhmp0019.oracle.com [141.146.116.25]) by aserv0122.oracle.com (8.13.8/8.13.8) with ESMTP id u3UHt9Ox013115; Sat, 30 Apr 2016 17:55:10 GMT In-Reply-To: <<83lh3vnh8z.fsf@gnu.org>> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6744.5000 (x86)] X-Source-IP: aserv0021.oracle.com [141.146.126.233] 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:117403 Archived-At: > > > > The doc string says only what this function does "When called > > > > interactively". It says nothing about what it does when called fro= m > > > > Lisp. Please complete the description of the function, to take car= e > > > > 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. >=20 > Which is what it does. Nope. > > Only after that should it describe use of the command from > > Lisp code. >=20 > Which is what it does. >=20 > > The first line of the doc string should not be the first line > > of the doc string. >=20 > You are contradicting yourself. You are playing word games. The first doc-string line should say what the command does interactively: Read a Lisp expression, evaluate it, and print the value in the echo area= . ^^^^ ^^^^ ^^^^^ Subsequent lines can describe the behavior (if different) when called from Lisp, and they can (and usually should) describe the arguments.