1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-05 11:45:45 +00:00

eql doc improvements

* doc/lispref/numbers.texi (Comparison of Numbers):
Copy some useful text from eql help string.
* src/fns.c (Feql): In doc string, say that eql also compares
integers by value.
This commit is contained in:
Paul Eggert 2020-10-13 10:04:21 -07:00
parent 993116eec9
commit 60d6e3fead
2 changed files with 5 additions and 0 deletions

View File

@ -450,6 +450,10 @@ numbers. It compares numbers by type and numeric value, so that
@code{(eql 1.0 1)} returns @code{nil}, but @code{(eql 1.0 1.0)} and
@code{(eql 1 1)} both return @code{t}. This can be used to compare
large integers as well as small ones.
Floating-point values with the same sign, exponent and fraction are @code{eql}.
This differs from numeric comparison: @code{(eql 0.0 -0.0)} returns
@code{nil} and @code{(eql 0.0e+NaN 0.0e+NaN)} returns @code{t},
whereas @code{=} does the opposite.
@end defun
@defun /= number-or-marker1 number-or-marker2

View File

@ -2295,6 +2295,7 @@ The PLIST is modified by side effects. */)
DEFUN ("eql", Feql, Seql, 2, 2, 0,
doc: /* Return t if the two args are `eq' or are indistinguishable numbers.
Integers with the same value are `eql'.
Floating-point values with the same sign, exponent and fraction are `eql'.
This differs from numeric comparison: (eql 0.0 -0.0) returns nil and
\(eql 0.0e+NaN 0.0e+NaN) returns t, whereas `=' does the opposite. */)