[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#19116: 25.0.50; doc string of `eval-expression'
From: |
Eli Zaretskii |
Subject: |
bug#19116: 25.0.50; doc string of `eval-expression' |
Date: |
Sat, 30 Apr 2016 20:22:52 +0300 |
> 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.