mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-22 05:31:01 -08:00
Code Issues Projects Releases Wiki Activity

Don't mention cl-cXXXr aliases in cl-lib manual

Browse source 
* doc/misc/cl.texi (Lists, List Functions, Efficiency Concerns): Don't
mention 'cl-cXXXr' compatibility aliases for built-in 'cXXXr'
functions.  They shouldn't be used in new code.
This commit is contained in:
Stefan Kangas 2022-07-12 13:41:28 +02:00
parent 9183d1672c
commit a3dab1e621
1 changed files with 3 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/misc/cl.texi
View file

@ -3668,7 +3668,7 @@ a merged sequence which is (stably) sorted according to
The functions described here operate on lists. The functions described here operate on lists.
@menu @menu
* List Functions:: @code{cl-caddr}, @code{cl-first}, @code{cl-list*}, etc. * List Functions:: @code{cl-first}, @code{cl-list*}, etc.
* Substitution of Expressions:: @code{cl-subst}, @code{cl-sublis}, etc. * Substitution of Expressions:: @code{cl-subst}, @code{cl-sublis}, etc.
* Lists as Sets:: @code{cl-member}, @code{cl-adjoin}, @code{cl-union}, etc. * Lists as Sets:: @code{cl-member}, @code{cl-adjoin}, @code{cl-union}, etc.
* Association Lists:: @code{cl-assoc}, @code{cl-acons}, @code{cl-pairlis}, etc. * Association Lists:: @code{cl-assoc}, @code{cl-acons}, @code{cl-pairlis}, etc.
@ -3681,14 +3681,6 @@ The functions described here operate on lists.
This section describes a number of simple operations on lists, This section describes a number of simple operations on lists,
i.e., chains of cons cells. i.e., chains of cons cells.
@defun cl-caddr x
This function is equivalent to @code{(car (cdr (cdr @var{x})))}.
Likewise, this package aliases all 24 @code{c@var{xxx}r} functions
where @var{xxx} is up to four @samp{a}s and/or @samp{d}s.
All of these functions are @code{setf}-able, and calls to them
are expanded inline by the byte-compiler for maximum efficiency.
@end defun
@defun cl-first x @defun cl-first x
This function is a synonym for @code{(car @var{x})}. Likewise, This function is a synonym for @code{(car @var{x})}. Likewise,
the functions @code{cl-second}, @code{cl-third}, @dots{}, through the functions @code{cl-second}, @code{cl-third}, @dots{}, through
@ -4465,8 +4457,8 @@ For example,
@end example @end example
@end ignore @end ignore
Note that @code{cl-adjoin}, @code{cl-caddr}, and @code{cl-member} all Note that @code{cl-adjoin} and @code{cl-member} have built-in compiler
have built-in compiler macros to optimize them in common cases. macros to optimize them in common cases.
@end defun @end defun
@appendixsec Error Checking @appendixsec Error Checking