Mercurial > emacs
comparison lispref/tips.texi @ 16736:981e116b4ac6
Minor cleanups for overfull hboxes.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Fri, 20 Dec 1996 00:09:23 +0000 |
parents | 9fa09185bca0 |
children | 96762d1abb7c |
comparison
equal
deleted
inserted
replaced
16735:940b9fcc1da6 | 16736:981e116b4ac6 |
---|---|
448 @end ifinfo | 448 @end ifinfo |
449 | 449 |
450 @item | 450 @item |
451 Don't write key sequences directly in documentation strings. Instead, | 451 Don't write key sequences directly in documentation strings. Instead, |
452 use the @samp{\\[@dots{}]} construct to stand for them. For example, | 452 use the @samp{\\[@dots{}]} construct to stand for them. For example, |
453 instead of writing @samp{C-f}, write @samp{\\[forward-char]}. When | 453 instead of writing @samp{C-f}, write the construct |
454 Emacs displays the documentation string, it substitutes whatever key is | 454 @samp{\\[forward-char]}. When Emacs displays the documentation string, |
455 currently bound to @code{forward-char}. (This is normally @samp{C-f}, | 455 it substitutes whatever key is currently bound to @code{forward-char}. |
456 but it may be some other character if the user has moved key bindings.) | 456 (This is normally @samp{C-f}, but it may be some other character if the |
457 @xref{Keys in Documentation}. | 457 user has moved key bindings.) @xref{Keys in Documentation}. |
458 | 458 |
459 @item | 459 @item |
460 In documentation strings for a major mode, you will want to refer to the | 460 In documentation strings for a major mode, you will want to refer to the |
461 key bindings of that mode's local map, rather than global ones. | 461 key bindings of that mode's local map, rather than global ones. |
462 Therefore, use the construct @samp{\\<@dots{}>} once in the | 462 Therefore, use the construct @samp{\\<@dots{}>} once in the |