all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: larsi@gnus.org, 19116@debbugs.gnu.org
Subject: bug#19116: 25.0.50; doc string of `eval-expression'
Date: Sat, 30 Apr 2016 09:55:08 -0800 (GMT-08:00)	[thread overview]
Message-ID: <f8488fbe-4e7b-4bab-b91d-7751acf610ab@default> (raw)
In-Reply-To: <<83lh3vnh8z.fsf@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.

Nope.

> > 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.

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.







  parent reply	other threads:[~2016-04-30 17:55 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-20  3:06 bug#19116: 25.0.50; doc string of `eval-expression' Drew Adams
2016-04-30 15:19 ` Lars Ingebrigtsen
2016-04-30 17:04   ` Drew Adams
2016-04-30 17:22     ` Eli Zaretskii
     [not found]   ` <<b30dc17d-8538-4aef-aa01-11b68cb8f845@default>
     [not found]     ` <<83lh3vnh8z.fsf@gnu.org>
2016-04-30 17:55       ` Drew Adams [this message]
2016-04-30 18:25         ` Eli Zaretskii
     [not found]   ` <<<b30dc17d-8538-4aef-aa01-11b68cb8f845@default>
     [not found]     ` <<<83lh3vnh8z.fsf@gnu.org>
     [not found]       ` <<f8488fbe-4e7b-4bab-b91d-7751acf610ab@default>
     [not found]         ` <<83eg9nneco.fsf@gnu.org>
2016-04-30 18:38           ` Drew Adams

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=f8488fbe-4e7b-4bab-b91d-7751acf610ab@default \
    --to=drew.adams@oracle.com \
    --cc=19116@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.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.