diff options
| author | Richard M. Stallman <rms@gnu.org> | 1994-12-23 15:11:57 +0000 |
|---|---|---|
| committer | Richard M. Stallman <rms@gnu.org> | 1994-12-23 15:11:57 +0000 |
| commit | e0d326687608273ce93b9d5d30ec629ec3e027b6 (patch) | |
| tree | 0e64b68bd8e1fff0703e42098823e36dd9616af2 /lispref/tips.texi | |
| parent | 53ece92895439718e96fce412707df089c31485e (diff) | |
| download | emacs-e0d326687608273ce93b9d5d30ec629ec3e027b6.tar.gz | |
Recommend doc strings for all functions and variables.
Diffstat (limited to 'lispref/tips.texi')
| -rw-r--r-- | lispref/tips.texi | 6 |
1 files changed, 4 insertions, 2 deletions
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 |