Mercurial > emacs
diff lispref/tips.texi @ 22252:40089afa2b1d
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 26 May 1998 18:56:56 +0000 |
parents | d4ac295a98b3 |
children | 1e9786a5c63d |
line wrap: on
line diff
--- a/lispref/tips.texi Tue May 26 18:27:47 1998 +0000 +++ b/lispref/tips.texi Tue May 26 18:56:56 1998 +0000 @@ -354,7 +354,7 @@ @end example @item -If calling a small function accounts for a substantial part of your +If calling a small function accounts for a substantial part of your program's running time, make the function inline. This eliminates the function call overhead. Since making a function inline reduces the flexibility of changing the program, don't do it unless it gives @@ -396,7 +396,7 @@ @item For consistency, phrase the verb in the first sentence of a -documentation string as an infinitive with ``to'' omitted. For +function's documentation string as an infinitive with ``to'' omitted. For instance, use ``Return the cons of A and B.'' in preference to ``Returns the cons of A and B@.'' Usually it looks good to do likewise for the rest of the first paragraph. Subsequent paragraphs usually look better @@ -478,8 +478,8 @@ convention, with single-quotes for all symbols.) @end ifinfo -Help mode automatically creates hyperlinks when documentation strings -use symbol names inside single quotes, when the symbol has either a +Help mode automatically creates a hyperlink when a documentation string +uses a symbol name inside single quotes, if the symbol has either a function or a variable definition. You do not need to do anything special to make use of this feature. However, when a symbol has both a function definition and a variable definition, and you want to refer to