X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/3e248c3b5b309bc03eb5f70762d3f5671d51f996..HEAD:/math/mpreduce.h

diff --git a/math/mpreduce.h b/math/mpreduce.h
index 80fb113..efac88f 100644
--- 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.
  */