mirror of
git://git.sv.gnu.org/emacs.git
synced 2026-02-16 09:14:18 +00:00
; Improve indexing in the ELisp manual
* doc/lispref/functions.texi (Function Names): * doc/lispref/variables.texi (Tips for Defining): Improve indexing.
This commit is contained in:
parent
a269bcb86b
commit
16b10d7617
2 changed files with 4 additions and 0 deletions
|
|
@ -674,6 +674,7 @@ variable; these two uses of a symbol are independent and do not
|
|||
conflict. (This is not the case in some dialects of Lisp, like
|
||||
Scheme.)
|
||||
|
||||
@cindex internal functions, naming conventions
|
||||
By convention, if a function's symbol consists of two names
|
||||
separated by @samp{--}, the function is intended for internal use and
|
||||
the first part names the file defining the function. For example, a
|
||||
|
|
|
|||
|
|
@ -617,6 +617,8 @@ float-pi
|
|||
|
||||
@node Tips for Defining
|
||||
@section Tips for Defining Variables Robustly
|
||||
@cindex variables, naming conventions
|
||||
@cindex naming conventions, variables
|
||||
|
||||
When you define a variable whose value is a function, or a list of
|
||||
functions, use a name that ends in @samp{-function} or
|
||||
|
|
@ -659,6 +661,7 @@ The value is a whole shell command.
|
|||
@item @dots{}-switches
|
||||
The value specifies options for a command.
|
||||
|
||||
@cindex internal variables, naming conventions
|
||||
@item @var{prefix}--@dots{}
|
||||
The variable is intended for internal use and is defined in the file
|
||||
@file{@var{prefix}.el}. (Emacs code contributed before 2018 may
|
||||
|
|
|
|||
Loading…
Reference in a new issue