[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#19116: 25.0.50; doc string of `eval-expression'

From: Drew Adams
Subject: bug#19116: 25.0.50; doc string of `eval-expression'
Date: Sat, 30 Apr 2016 09:04:12 -0800 (GMT-08:00)

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

Only after that should it describe use of the command from
Lisp code.

The first line of the doc string should not be the first line
of the doc string.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]