1 |
@c -*-texinfo-*- |
@c -*-texinfo-*- |
2 |
@c This is part of the GNU Emacs Lisp Reference Manual. |
@c This is part of the GNU Emacs Lisp Reference Manual. |
3 |
@c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999 |
@c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999 |
4 |
@c Free Software Foundation, Inc. |
@c Free Software Foundation, Inc. |
5 |
@c See the file elisp.texi for copying conditions. |
@c See the file elisp.texi for copying conditions. |
6 |
@setfilename ../info/tips |
@setfilename ../info/tips |
7 |
@node Tips, GNU Emacs Internals, GPL, Top |
@node Tips, GNU Emacs Internals, GPL, Top |
435 |
search functions can be used. |
search functions can be used. |
436 |
|
|
437 |
@item |
@item |
438 |
Certain built-in functions are handled specially in byte-compiled code, |
Certain built-in functions are handled specially in byte-compiled code, |
439 |
avoiding the need for an ordinary function call. It is a good idea to |
avoiding the need for an ordinary function call. It is a good idea to |
440 |
use these functions rather than alternatives. To see whether a function |
use these functions rather than alternatives. To see whether a function |
441 |
is handled specially by the compiler, examine its @code{byte-compile} |
is handled specially by the compiler, examine its @code{byte-compile} |
508 |
variable. Please use complete sentences for the rest of the text too. |
variable. Please use complete sentences for the rest of the text too. |
509 |
|
|
510 |
@item |
@item |
511 |
|
The first line should mention all the important arguments of the |
512 |
|
function, and should mention them in the order that they are written |
513 |
|
in a function call. If the function has many arguments, then it is |
514 |
|
not feasible to mention them all in the first line; in that case, the |
515 |
|
first line should mention the first few arguments, including the most |
516 |
|
important arguments. |
517 |
|
|
518 |
|
@item |
519 |
For consistency, phrase the verb in the first sentence of a function's |
For consistency, phrase the verb in the first sentence of a function's |
520 |
documentation string as an imperative--for instance, use ``Return the |
documentation string as an imperative--for instance, use ``Return the |
521 |
cons of A and B.'' in preference to ``Returns the cons of A and B@.'' |
cons of A and B.'' in preference to ``Returns the cons of A and B@.'' |
545 |
|
|
546 |
@item |
@item |
547 |
Do not start or end a documentation string with whitespace. |
Do not start or end a documentation string with whitespace. |
548 |
|
|
549 |
@item |
@item |
550 |
@strong{Do not} indent subsequent lines of a documentation string so |
@strong{Do not} indent subsequent lines of a documentation string so |
551 |
that the text is lined up in the source code with the text of the first |
that the text is lined up in the source code with the text of the first |