diff options
| author | Philipp Stephani | 2019-04-18 23:31:00 +0200 |
|---|---|---|
| committer | Philipp Stephani | 2019-04-18 23:31:00 +0200 |
| commit | e712a8fe0929a18eaf3f4ec83b023f475afdc4d4 (patch) | |
| tree | 27d8602b9bbbc1da32ac5bb27a6b624c43ed005a | |
| parent | ee4ba5c8fe42311f676f4553504c3f61a3eb0168 (diff) | |
| download | emacs-e712a8fe0929a18eaf3f4ec83b023f475afdc4d4.tar.gz emacs-e712a8fe0929a18eaf3f4ec83b023f475afdc4d4.zip | |
Update module documentation for bignum support.
* doc/lispref/internals.texi (Module Values): Update documentation for
'make_integer' and 'extract_integer' for bignum support.
| -rw-r--r-- | doc/lispref/internals.texi | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index 8ebe47d9ad7..fc5ce594e61 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. | |||
| 1378 | This function returns the value of a Lisp integer specified by | 1378 | This function returns the value of a Lisp integer specified by |
| 1379 | @var{arg}. The C data type of the return value, @code{intmax_t}, is | 1379 | @var{arg}. The C data type of the return value, @code{intmax_t}, is |
| 1380 | the widest integral data type supported by the C compiler, typically | 1380 | the widest integral data type supported by the C compiler, typically |
| 1381 | @w{@code{long long}}. | 1381 | @w{@code{long long}}. If the value of @var{arg} doesn't fit into an |
| 1382 | @code{intmax_t}, the function signals an error using the error symbol | ||
| 1383 | @code{overflow-error}. | ||
| 1382 | @end deftypefn | 1384 | @end deftypefn |
| 1383 | 1385 | ||
| 1384 | @deftypefn Function double extract_float (emacs_env *@var{env}, emacs_value @var{arg}) | 1386 | @deftypefn Function double extract_float (emacs_env *@var{env}, emacs_value @var{arg}) |
| @@ -1440,11 +1442,10 @@ objects from basic C data types. They all return the created | |||
| 1440 | 1442 | ||
| 1441 | @deftypefn Function emacs_value make_integer (emacs_env *@var{env}, intmax_t @var{n}) | 1443 | @deftypefn Function emacs_value make_integer (emacs_env *@var{env}, intmax_t @var{n}) |
| 1442 | This function takes an integer argument @var{n} and returns the | 1444 | This function takes an integer argument @var{n} and returns the |
| 1443 | corresponding @code{emacs_value} object. It raises the | 1445 | corresponding @code{emacs_value} object. It returns either a fixnum |
| 1444 | @code{overflow-error} error condition if the value of @var{n} cannot | 1446 | or a bignum depending on whether the value of @var{n} is inside the |
| 1445 | be represented as an Emacs integer, i.e.@: is not inside the limits | 1447 | limits set by @code{most-negative-fixnum} and |
| 1446 | set by @code{most-negative-fixnum} and @code{most-positive-fixnum} | 1448 | @code{most-positive-fixnum} (@pxref{Integer Basics}). |
| 1447 | (@pxref{Integer Basics}). | ||
| 1448 | @end deftypefn | 1449 | @end deftypefn |
| 1449 | 1450 | ||
| 1450 | @deftypefn Function emacs_value make_float (emacs_env *@var{env}, double @var{d}) | 1451 | @deftypefn Function emacs_value make_float (emacs_env *@var{env}, double @var{d}) |