Mercurial > emacs
comparison 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 |
comparison
equal
deleted
inserted
replaced
22251:5989fa41cda6 | 22252:40089afa2b1d |
---|---|
352 @result{} byte-compile-two-args | 352 @result{} byte-compile-two-args |
353 @end group | 353 @end group |
354 @end example | 354 @end example |
355 | 355 |
356 @item | 356 @item |
357 If calling a small function accounts for a substantial part of your | 357 If calling a small function accounts for a substantial part of your |
358 program's running time, make the function inline. This eliminates | 358 program's running time, make the function inline. This eliminates |
359 the function call overhead. Since making a function inline reduces | 359 the function call overhead. Since making a function inline reduces |
360 the flexibility of changing the program, don't do it unless it gives | 360 the flexibility of changing the program, don't do it unless it gives |
361 a noticeable speedup in something slow enough that users care about | 361 a noticeable speedup in something slow enough that users care about |
362 the speed. @xref{Inline Functions}. | 362 the speed. @xref{Inline Functions}. |
394 should be made up of complete sentences also, but they may be filled if | 394 should be made up of complete sentences also, but they may be filled if |
395 that looks good. | 395 that looks good. |
396 | 396 |
397 @item | 397 @item |
398 For consistency, phrase the verb in the first sentence of a | 398 For consistency, phrase the verb in the first sentence of a |
399 documentation string as an infinitive with ``to'' omitted. For | 399 function's documentation string as an infinitive with ``to'' omitted. For |
400 instance, use ``Return the cons of A and B.'' in preference to ``Returns | 400 instance, use ``Return the cons of A and B.'' in preference to ``Returns |
401 the cons of A and B@.'' Usually it looks good to do likewise for the | 401 the cons of A and B@.'' Usually it looks good to do likewise for the |
402 rest of the first paragraph. Subsequent paragraphs usually look better | 402 rest of the first paragraph. Subsequent paragraphs usually look better |
403 if they have proper subjects. | 403 if they have proper subjects. |
404 | 404 |
476 around it. For example: @samp{lambda}. There are two exceptions: write | 476 around it. For example: @samp{lambda}. There are two exceptions: write |
477 t and nil without single-quotes. (In this manual, we use a different | 477 t and nil without single-quotes. (In this manual, we use a different |
478 convention, with single-quotes for all symbols.) | 478 convention, with single-quotes for all symbols.) |
479 @end ifinfo | 479 @end ifinfo |
480 | 480 |
481 Help mode automatically creates hyperlinks when documentation strings | 481 Help mode automatically creates a hyperlink when a documentation string |
482 use symbol names inside single quotes, when the symbol has either a | 482 uses a symbol name inside single quotes, if the symbol has either a |
483 function or a variable definition. You do not need to do anything | 483 function or a variable definition. You do not need to do anything |
484 special to make use of this feature. However, when a symbol has both a | 484 special to make use of this feature. However, when a symbol has both a |
485 function definition and a variable definition, and you want to refer to | 485 function definition and a variable definition, and you want to refer to |
486 just one of them, you can specify which one by writing one of the words | 486 just one of them, you can specify which one by writing one of the words |
487 @samp{variable}, @samp{option}, @samp{function}, or @samp{command}, | 487 @samp{variable}, @samp{option}, @samp{function}, or @samp{command}, |