mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

; Improve indexing in ELisp manual

Browse source 
* doc/lispref/tips.texi (Documentation Tips, Coding Conventions)
(Key Binding Conventions, Programming Tips, Compilation Tips)
(Warning Tips, Comment Tips, Library Headers): Improve indexing.
This commit is contained in:
Eli Zaretskii 2023-11-16 08:24:13 +02:00
parent 4e406bb420
commit 5f3309f6b0
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/lispref/tips.texi
View file

@ -43,6 +43,7 @@ in batch mode, e.g., with a command run by @kbd{@w{M-x compile
@section Emacs Lisp Coding Conventions @section Emacs Lisp Coding Conventions
@cindex coding conventions in Emacs Lisp @cindex coding conventions in Emacs Lisp
@cindex conventions for Emacs Lisp programs
Here are conventions that you should follow when writing Emacs Lisp Here are conventions that you should follow when writing Emacs Lisp
code intended for widespread use: code intended for widespread use:
@ -264,6 +265,7 @@ which are lists of directory names.
@node Key Binding Conventions @node Key Binding Conventions
@section Key Binding Conventions @section Key Binding Conventions
@cindex key binding, conventions for @cindex key binding, conventions for
@cindex conventions for key bindings
@itemize @bullet @itemize @bullet
@item @item
@ -345,6 +347,7 @@ after @key{ESC}. In these states, you should define @kbd{@key{ESC}
@node Programming Tips @node Programming Tips
@section Emacs Programming Tips @section Emacs Programming Tips
@cindex programming conventions @cindex programming conventions
@cindex conventions for Emacs programming
Following these conventions will make your program fit better Following these conventions will make your program fit better
into Emacs when it runs. 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 @section Tips for Making Compiled Code Fast
@cindex execution speed @cindex execution speed
@cindex speedups @cindex speedups
@cindex tips for faster Lisp code
Here are ways of improving the execution speed of byte-compiled Here are ways of improving the execution speed of byte-compiled
Lisp programs. Lisp programs.
@ -531,6 +535,7 @@ the speed. @xref{Inline Functions}.
@node Warning Tips @node Warning Tips
@section Tips for Avoiding Compiler Warnings @section Tips for Avoiding Compiler Warnings
@cindex byte compiler warnings, how to avoid @cindex byte compiler warnings, how to avoid
@cindex warnings from byte compiler
@itemize @bullet @itemize @bullet
@item @item
@ -585,6 +590,8 @@ is to put it inside @code{with-no-warnings}. @xref{Compiler Errors}.
@node Documentation Tips @node Documentation Tips
@section Tips for Documentation Strings @section Tips for Documentation Strings
@cindex documentation strings, conventions and tips @cindex documentation strings, conventions and tips
@cindex tips for documentation strings
@cindex conventions for documentation strings
@findex checkdoc-minor-mode @findex checkdoc-minor-mode
Here are some tips and conventions for the writing of documentation 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 @node Comment Tips
@section Tips on Writing Comments @section Tips on Writing Comments
@cindex comments, Lisp convention for @cindex comments, Lisp convention for
@cindex conventions for Lisp comments
We recommend these conventions for comments: We recommend these conventions for comments:
@ -1030,6 +1038,7 @@ semicolons.
@section Conventional Headers for Emacs Libraries @section Conventional Headers for Emacs Libraries
@cindex header comments @cindex header comments
@cindex library header comments @cindex library header comments
@cindex conventions for library header comments
Emacs has conventions for using special comments in Lisp libraries Emacs has conventions for using special comments in Lisp libraries
to divide them into sections and give information such as who wrote to divide them into sections and give information such as who wrote