« Return to Thread: [PATCH] Error in String docs

[PATCH] Error in String docs

by Jesper Christensen :: Rate this Message:

Hi!

My first patch. Hope it's correct. :)

Somebody confused "modulo" and "and" in the docs for String.sum
str modulo <code>2n - 1</code>
It should be
str modulo <code>2n</code>
or even better
str modulo <code>2**n</code>

A patch is pasted in below.

Regards,
Jesper

Index: string.c
===================================================================
--- string.c (revision 22183)
+++ string.c (working copy)
@@ -6428,7 +6428,7 @@
* Returns a basic n-bit checksum of the characters in str,
* where n is the optional <code>Fixnum</code> parameter, defaulting
* to 16. The result is simply the sum of the binary value of each
character in
- * str modulo <code>2n - 1</code>. This is not a particularly good
+ * str modulo <code>2**n</code>. This is not a particularly good
* checksum.
*/

« Return to Thread: [PATCH] Error in String docs