[Gmp-commit] /var/hg/gmp: doc/gmp.texi: Slightly better documentation for mpz...

[mercurial at gmplib.org]

details:   /var/hg/gmp/rev/1a2ad0e32507
changeset: 18483:1a2ad0e32507
user:      Marco Bodrato <bodrato at mail.dm.unipi.it>
date:      Mon Feb 03 17:52:54 2025 +0100
description:
doc/gmp.texi: Slightly better documentation for mpz_limbs_write.

diffstat:

 doc/gmp.texi |  3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diffs (13 lines):

diff -r d6c6436467ab -r 1a2ad0e32507 doc/gmp.texi
--- a/doc/gmp.texi	Sat Feb 01 19:36:16 2025 +0100
+++ b/doc/gmp.texi	Mon Feb 03 17:52:54 2025 +0100
@@ -4261,7 +4261,8 @@
 Return a pointer to the limb array, intended for write access. The array is
 reallocated as needed, to make room for @var{n} limbs. Requires @math{@var{n}
 > 0}. The @code{mpz_limbs_modify} function returns an array that holds the old
-absolute value of @var{x}, while @code{mpz_limbs_write} may destroy the old
+absolute value of @var{x} (in the first @code{mpz_size}(@var{x}) limbs, the
+other ones are undefined), while @code{mpz_limbs_write} may destroy the old
 value and return an array with unspecified contents.
 @end deftypefun