diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2023-11-16 08:24:13 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2023-11-16 08:24:13 +0200 |
| commit | 5f3309f6b0fb6d0b485c6e1cc444aff0beb0919c (patch) | |
| tree | 03915182d8a0344f297e688b6ad32a2353f8c3bd /doc/lispref | |
| parent | 4e406bb4208175c50c26e513011f646b67191d2e (diff) | |
| download | emacs-5f3309f6b0fb6d0b485c6e1cc444aff0beb0919c.tar.gz emacs-5f3309f6b0fb6d0b485c6e1cc444aff0beb0919c.tar.bz2 emacs-5f3309f6b0fb6d0b485c6e1cc444aff0beb0919c.zip | |
; Improve indexing in ELisp manual
* doc/lispref/tips.texi (Documentation Tips, Coding Conventions)
(Key Binding Conventions, Programming Tips, Compilation Tips)
(Warning Tips, Comment Tips, Library Headers): Improve indexing.
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/tips.texi | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index f760b2554f0..edc16181d19 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -43,6 +43,7 @@ in batch mode, e.g., with a command run by @kbd{@w{M-x compile @section Emacs Lisp Coding Conventions @cindex coding conventions in Emacs Lisp +@cindex conventions for Emacs Lisp programs Here are conventions that you should follow when writing Emacs Lisp code intended for widespread use: @@ -264,6 +265,7 @@ which are lists of directory names. @node Key Binding Conventions @section Key Binding Conventions @cindex key binding, conventions for +@cindex conventions for key bindings @itemize @bullet @item @@ -345,6 +347,7 @@ after @key{ESC}. In these states, you should define @kbd{@key{ESC} @node Programming Tips @section Emacs Programming Tips @cindex programming conventions +@cindex conventions for Emacs programming Following these conventions will make your program fit better into Emacs when it runs. @@ -477,6 +480,7 @@ buffer and let the user switch back at will. @xref{Recursive Editing}. @section Tips for Making Compiled Code Fast @cindex execution speed @cindex speedups +@cindex tips for faster Lisp code Here are ways of improving the execution speed of byte-compiled Lisp programs. @@ -531,6 +535,7 @@ the speed. @xref{Inline Functions}. @node Warning Tips @section Tips for Avoiding Compiler Warnings @cindex byte compiler warnings, how to avoid +@cindex warnings from byte compiler @itemize @bullet @item @@ -585,6 +590,8 @@ is to put it inside @code{with-no-warnings}. @xref{Compiler Errors}. @node Documentation Tips @section Tips for Documentation Strings @cindex documentation strings, conventions and tips +@cindex tips for documentation strings +@cindex conventions for documentation strings @findex checkdoc-minor-mode Here are some tips and conventions for the writing of documentation @@ -915,6 +922,7 @@ versions, there is no need for this work-around. @node Comment Tips @section Tips on Writing Comments @cindex comments, Lisp convention for +@cindex conventions for Lisp comments We recommend these conventions for comments: @@ -1030,6 +1038,7 @@ semicolons. @section Conventional Headers for Emacs Libraries @cindex header comments @cindex library header comments +@cindex conventions for library header comments Emacs has conventions for using special comments in Lisp libraries to divide them into sections and give information such as who wrote |