From: Richard M. Stallman Date: Fri, 23 Dec 1994 15:11:57 +0000 (+0000) Subject: Recommend doc strings for all functions and variables. X-Git-Tag: emacs-19.34~5631 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e0d326687608273ce93b9d5d30ec629ec3e027b6;p=emacs.git Recommend doc strings for all functions and variables. --- diff --git a/lispref/tips.texi b/lispref/tips.texi index f6e240c9c41..a582202926b 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi @@ -304,8 +304,10 @@ Every command, function, or variable intended for users to know about should have a documentation string. @item -An internal subroutine of a Lisp program need not have a documentation -string, and you can save space by using a comment instead. +An internal variable or subroutine of a Lisp program might as well have +a documentation string. In earlier Emacs versions, you could save space +by using a comment instead of a documentation string, but that is no +longer the case. @item The first line of the documentation string should consist of one or two