[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master e712a8f 2/2: Update module documentation for bignum
From: |
Philipp Stephani |
Subject: |
[Emacs-diffs] master e712a8f 2/2: Update module documentation for bignum support. |
Date: |
Thu, 18 Apr 2019 17:31:40 -0400 (EDT) |
branch: master
commit e712a8fe0929a18eaf3f4ec83b023f475afdc4d4
Author: Philipp Stephani <address@hidden>
Commit: Philipp Stephani <address@hidden>
Update module documentation for bignum support.
* doc/lispref/internals.texi (Module Values): Update documentation for
'make_integer' and 'extract_integer' for bignum support.
---
doc/lispref/internals.texi | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi
index 8ebe47d..fc5ce59 100644
--- a/doc/lispref/internals.texi
+++ b/doc/lispref/internals.texi
@@ -1378,7 +1378,9 @@ can be used to obtain the type of a @code{emacs_value}
object.
This function returns the value of a Lisp integer specified by
@var{arg}. The C data type of the return value, @code{intmax_t}, is
the widest integral data type supported by the C compiler, typically
address@hidden@code{long long}}.
address@hidden@code{long long}}. If the value of @var{arg} doesn't fit into an
address@hidden, the function signals an error using the error symbol
address@hidden
@end deftypefn
@deftypefn Function double extract_float (emacs_env address@hidden,
emacs_value @var{arg})
@@ -1440,11 +1442,10 @@ objects from basic C data types. They all return the
created
@deftypefn Function emacs_value make_integer (emacs_env address@hidden,
intmax_t @var{n})
This function takes an integer argument @var{n} and returns the
-corresponding @code{emacs_value} object. It raises the
address@hidden error condition if the value of @var{n} cannot
-be represented as an Emacs integer, i.e.@: is not inside the limits
-set by @code{most-negative-fixnum} and @code{most-positive-fixnum}
-(@pxref{Integer Basics}).
+corresponding @code{emacs_value} object. It returns either a fixnum
+or a bignum depending on whether the value of @var{n} is inside the
+limits set by @code{most-negative-fixnum} and
address@hidden (@pxref{Integer Basics}).
@end deftypefn
@deftypefn Function emacs_value make_float (emacs_env address@hidden, double
@var{d})