GNU bug report logs - #19932
25.0.50; doc string of `elisp--eval-last-sexp'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Mon, 23 Feb 2015 21:21:02 UTC

Severity: minor

Found in version 25.0.50

Done: Nicolas Richard <theonewiththeevillook <at> yahoo.fr>

Bug is archived. No further changes may be made.

Full log

Message #11 received at 19932 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Dmitry Gutov <dgutov <at> yandex.ru>, 19932 <at> debbugs.gnu.org
Subject: RE: bug#19932: 25.0.50; doc string of `elisp--eval-last-sexp'
Date: Tue, 24 Feb 2015 13:26:23 -0800 (PST)

> > .. should not mention the prefix arg.  This is not a command, and the
> > function code does not access `current-prefix-arg'.
> 
> Maybe it should just be undocumented. It's a private function, and it
> duplicates the docstring of its only caller.

Maybe it should be documented properly.  Emacs is the self-documenting
editor.  Maybe developers should drop the bad habit of thinking of
documentation as only a chore and as only for others.

There is nothing "private" in Emacs Lisp - this is not Java or C++.
And even Emacs "internal" developers deserve to take advantage of
the self-documentation Emacs is intended to provide.

The duplication of its caller's docstring is the bug - it should
have its own documentation.
This bug report was last modified 10 years and 180 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.