Mercurial > emacs
comparison lispref/tips.texi @ 76841:fc9d442f98d2
Improve indexing.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 31 Mar 2007 17:27:34 +0000 |
parents | afd36ac582f5 |
children | 55c9ef5f1559 |
comparison
equal
deleted
inserted
replaced
76840:0cdcaf11fa80 | 76841:fc9d442f98d2 |
---|---|
293 Otherwise, use your name. See also @xref{Library Headers}. | 293 Otherwise, use your name. See also @xref{Library Headers}. |
294 @end itemize | 294 @end itemize |
295 | 295 |
296 @node Key Binding Conventions | 296 @node Key Binding Conventions |
297 @section Key Binding Conventions | 297 @section Key Binding Conventions |
298 @cindex key binding, conventions for | |
298 | 299 |
299 @itemize @bullet | 300 @itemize @bullet |
300 @item | 301 @item |
301 @cindex mouse-2 | 302 @cindex mouse-2 |
302 @cindex references, following | 303 @cindex references, following |
372 @kbd{@key{ESC} @key{ESC}} instead. | 373 @kbd{@key{ESC} @key{ESC}} instead. |
373 @end itemize | 374 @end itemize |
374 | 375 |
375 @node Programming Tips | 376 @node Programming Tips |
376 @section Emacs Programming Tips | 377 @section Emacs Programming Tips |
378 @cindex programming conventions | |
377 | 379 |
378 Following these conventions will make your program fit better | 380 Following these conventions will make your program fit better |
379 into Emacs when it runs. | 381 into Emacs when it runs. |
380 | 382 |
381 @itemize @bullet | 383 @itemize @bullet |
557 the speed. @xref{Inline Functions}. | 559 the speed. @xref{Inline Functions}. |
558 @end itemize | 560 @end itemize |
559 | 561 |
560 @node Warning Tips | 562 @node Warning Tips |
561 @section Tips for Avoiding Compiler Warnings | 563 @section Tips for Avoiding Compiler Warnings |
564 @cindex byte compiler warnings, how to avoid | |
562 | 565 |
563 @itemize @bullet | 566 @itemize @bullet |
564 @item | 567 @item |
565 Try to avoid compiler warnings about undefined free variables, by adding | 568 Try to avoid compiler warnings about undefined free variables, by adding |
566 dummy @code{defvar} definitions for these variables, like this: | 569 dummy @code{defvar} definitions for these variables, like this: |
597 is to put a call to @code{with-no-warnings} around it. | 600 is to put a call to @code{with-no-warnings} around it. |
598 @end itemize | 601 @end itemize |
599 | 602 |
600 @node Documentation Tips | 603 @node Documentation Tips |
601 @section Tips for Documentation Strings | 604 @section Tips for Documentation Strings |
605 @cindex documentation strings, conventions and tips | |
602 | 606 |
603 @findex checkdoc-minor-mode | 607 @findex checkdoc-minor-mode |
604 Here are some tips and conventions for the writing of documentation | 608 Here are some tips and conventions for the writing of documentation |
605 strings. You can check many of these conventions by running the command | 609 strings. You can check many of these conventions by running the command |
606 @kbd{M-x checkdoc-minor-mode}. | 610 @kbd{M-x checkdoc-minor-mode}. |
861 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | 865 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. |
862 @end itemize | 866 @end itemize |
863 | 867 |
864 @node Comment Tips | 868 @node Comment Tips |
865 @section Tips on Writing Comments | 869 @section Tips on Writing Comments |
870 @cindex comments, convention for | |
866 | 871 |
867 We recommend these conventions for where to put comments and how to | 872 We recommend these conventions for where to put comments and how to |
868 indent them: | 873 indent them: |
869 | 874 |
870 @table @samp | 875 @table @samp |