math/gfreduce.[ch]: Fix out-of-bounds memory access.

[u/mdw/catacomb] / math / mpreduce.h

diff --git a/math/mpreduce.h b/math/mpreduce.h
index 80fb113..efac88f 100644 (file)
--- a/math/mpreduce.h
+++ b/math/mpreduce.h
@@ -70,7 +70,10 @@ typedef struct mpreduce {
  * Arguments:  @gfreduce *r@ = structure to fill in
  *             @mp *x@ = an integer
  *
- * Returns:    Zero for success, nonzero on error.
+ * Returns:    Zero if successful; nonzero on failure.  The current
+ *             algorithm always succeeds when given positive @x@.  Earlier
+ *             versions used to fail on particular kinds of integers, but
+ *             this is guaranteed not to happen any more.
  *
  * Use:                Initializes a context structure for reduction.
  */