unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: 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 20:22:52 +0300	[thread overview]
Message-ID: <83lh3vnh8z.fsf@gnu.org> (raw)
In-Reply-To: <b30dc17d-8538-4aef-aa01-11b68cb8f845@default> (message from Drew Adams on Sat, 30 Apr 2016 09:04:12 -0800 (GMT-08:00))

> Date: Sat, 30 Apr 2016 09:04:12 -0800 (GMT-08:00)
> From: Drew Adams <drew.adams@oracle.com>
> 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.





  reply	other threads:[~2016-04-30 17:22 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 [this message]
     [not found]   ` <<b30dc17d-8538-4aef-aa01-11b68cb8f845@default>
     [not found]     ` <<83lh3vnh8z.fsf@gnu.org>
2016-04-30 17:55       ` Drew Adams
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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83lh3vnh8z.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=19116@debbugs.gnu.org \
    --cc=drew.adams@oracle.com \
    --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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).