aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2012-11-02 18:29:56 -0400
committerGlenn Morris2012-11-02 18:29:56 -0400
commit7fbf8f7bd9a23a7cd946b60b4a8ec45124433b17 (patch)
treedede17c24220eea2bc63ce8bd050faa631ce554f
parent7e8b50d9e556b1c8b393199995ef3ea85b9f4525 (diff)
downloademacs-7fbf8f7bd9a23a7cd946b60b4a8ec45124433b17.tar.gz
emacs-7fbf8f7bd9a23a7cd946b60b4a8ec45124433b17.zip
Undocument cl-floatp-safe, since it is no longer relevant
* doc/misc/cl.texi (Naming Conventions, Type Predicates, Macros) (Predicates on Numbers): No longer mention cl-floatp-safe.
-rw-r--r--doc/misc/ChangeLog5
-rw-r--r--doc/misc/cl.texi19
2 files changed, 17 insertions, 7 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index d719a02e32e..36f8d01bbd9 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
12012-11-02 Glenn Morris <rgm@gnu.org>
2
3 * cl.texi (Naming Conventions, Type Predicates, Macros)
4 (Predicates on Numbers): No longer mention cl-floatp-safe.
5
12012-11-01 Glenn Morris <rgm@gnu.org> 62012-11-01 Glenn Morris <rgm@gnu.org>
2 7
3 * cl.texi: General copyedits for style, line-breaks, etc. 8 * cl.texi: General copyedits for style, line-breaks, etc.
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index 4a728049ce8..9de8ee37165 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -229,7 +229,7 @@ by @code{cl--}. Here is a complete list of functions prefixed by
229 229
230@example 230@example
231cl-callf cl-callf2 cl-defsubst 231cl-callf cl-callf2 cl-defsubst
232cl-floatp-safe cl-letf cl-letf* 232cl-letf cl-letf*
233@end example 233@end example
234 234
235@c This is not uninteresting I suppose, but is of zero practical relevance 235@c This is not uninteresting I suppose, but is of zero practical relevance
@@ -239,13 +239,13 @@ they do not cause other components like @file{cl-extra} to be loaded.
239 239
240@example 240@example
241cl-evenp cl-oddp cl-minusp 241cl-evenp cl-oddp cl-minusp
242cl-plusp cl-floatp-safe cl-endp 242cl-plusp cl-endp cl-subst
243cl-copy-list cl-list* cl-ldiff 243cl-copy-list cl-list* cl-ldiff
244cl-rest cl-decf [1] cl-incf [1] 244cl-rest cl-decf [1] cl-incf [1]
245cl-acons cl-adjoin [2] cl-pairlis 245cl-acons cl-adjoin [2] cl-pairlis
246cl-pushnew [1,2] cl-declaim cl-proclaim 246cl-pushnew [1,2] cl-declaim cl-proclaim
247cl-caaar@dots{}cl-cddddr cl-first@dots{}cl-tenth 247cl-caaar@dots{}cl-cddddr cl-first@dots{}cl-tenth
248cl-subst cl-mapcar [3] 248cl-mapcar [3]
249@end example 249@end example
250 250
251@noindent 251@noindent
@@ -300,7 +300,8 @@ calls to it may be expanded into in-line code by the byte compiler.
300This is analogous to the @code{defsubst} form; 300This is analogous to the @code{defsubst} form;
301@code{cl-defsubst} uses a different method (compiler macros) which 301@code{cl-defsubst} uses a different method (compiler macros) which
302works in all versions of Emacs, and also generates somewhat more 302works in all versions of Emacs, and also generates somewhat more
303@c Really? 303@c For some examples,
304@c see http://lists.gnu.org/archive/html/emacs-devel/2012-11/msg00009.html
304efficient inline expansions. In particular, @code{cl-defsubst} 305efficient inline expansions. In particular, @code{cl-defsubst}
305arranges for the processing of keyword arguments, default values, 306arranges for the processing of keyword arguments, default values,
306etc., to be done at compile-time whenever possible. 307etc., to be done at compile-time whenever possible.
@@ -702,11 +703,13 @@ The type symbol @code{real} is a synonym for @code{number}, and
702The type symbols @code{character} and @code{string-char} match 703The type symbols @code{character} and @code{string-char} match
703integers in the range from 0 to 255. 704integers in the range from 0 to 255.
704 705
706@c No longer relevant, so covered by first item above (float -> floatp).
707@ignore
705@item 708@item
706The type symbol @code{float} uses the @code{cl-floatp-safe} predicate 709The type symbol @code{float} uses the @code{cl-floatp-safe} predicate
707defined by this package rather than @code{floatp}, so it will work 710defined by this package rather than @code{floatp}, so it will work
708@c FIXME are any such platforms still relevant?
709correctly even in Emacs versions without floating-point support. 711correctly even in Emacs versions without floating-point support.
712@end ignore
710 713
711@item 714@item
712The type list @code{(integer @var{low} @var{high})} represents all 715The type list @code{(integer @var{low} @var{high})} represents all
@@ -2551,7 +2554,7 @@ appears as a standard part of this package:
2551(cl-define-compiler-macro cl-member (&whole form a list &rest keys) 2554(cl-define-compiler-macro cl-member (&whole form a list &rest keys)
2552 (if (and (null keys) 2555 (if (and (null keys)
2553 (eq (car-safe a) 'quote) 2556 (eq (car-safe a) 'quote)
2554 (not (floatp-safe (cadr a)))) 2557 (not (floatp (cadr a))))
2555 (list 'memq a list) 2558 (list 'memq a list)
2556 form)) 2559 form))
2557@end example 2560@end example
@@ -2908,7 +2911,7 @@ This section defines a few simple Common Lisp operations on numbers
2908which were left out of Emacs Lisp. 2911which were left out of Emacs Lisp.
2909 2912
2910@menu 2913@menu
2911* Predicates on Numbers:: @code{cl-plusp}, @code{cl-oddp}, @code{cl-floatp-safe}, etc. 2914* Predicates on Numbers:: @code{cl-plusp}, @code{cl-oddp}, etc.
2912* Numerical Functions:: @code{abs}, @code{cl-floor}, etc. 2915* Numerical Functions:: @code{abs}, @code{cl-floor}, etc.
2913* Random Numbers:: @code{cl-random}, @code{cl-make-random-state}. 2916* Random Numbers:: @code{cl-random}, @code{cl-make-random-state}.
2914* Implementation Parameters:: @code{cl-most-positive-float}. 2917* Implementation Parameters:: @code{cl-most-positive-float}.
@@ -2941,11 +2944,13 @@ This predicate tests whether @var{integer} is even. It is an
2941error if the argument is not an integer. 2944error if the argument is not an integer.
2942@end defun 2945@end defun
2943 2946
2947@ignore
2944@defun cl-floatp-safe object 2948@defun cl-floatp-safe object
2945This predicate tests whether @var{object} is a floating-point 2949This predicate tests whether @var{object} is a floating-point
2946number. On systems that support floating-point, this is equivalent 2950number. On systems that support floating-point, this is equivalent
2947to @code{floatp}. On other systems, this always returns @code{nil}. 2951to @code{floatp}. On other systems, this always returns @code{nil}.
2948@end defun 2952@end defun
2953@end ignore
2949 2954
2950@node Numerical Functions 2955@node Numerical Functions
2951@section Numerical Functions 2956@section Numerical Functions