[DOC] Tweaks for Hash#rehash

BurdetteLamar · web-flow · commit 17f6a689629e · 2025-03-07T09:38:51.000-05:00
diff --git a/hash.c b/hash.c
@@ -1988,8 +1988,9 @@ rb_hash_rehash_i(VALUE key, VALUE value, VALUE arg)
  *  call-seq:
  *     rehash -> self
  *
- *  Rebuilds the hash table by recomputing the hash index for each key;
+ *  Rebuilds the hash table for +self+ by recomputing the hash index for each key;
  *  returns <tt>self</tt>.
+ *  Calling this method ensures that the hash table is valid.
  *
  *  The hash table becomes invalid if the hash value of a key
  *  has changed after the entry was created.

Original file line number	Diff line number	Diff line change
`@@ -1988,8 +1988,9 @@ rb_hash_rehash_i(VALUE key, VALUE value, VALUE arg)`
`1988`	`1988`	`* call-seq:`
`1989`	`1989`	`* rehash -> self`
`1990`	`1990`	`*`
`1991`		`- * Rebuilds the hash table by recomputing the hash index for each key;`
	`1991`	`+ * Rebuilds the hash table for +self+ by recomputing the hash index for each key;`
`1992`	`1992`	`* returns <tt>self</tt>.`
	`1993`	`+ * Calling this method ensures that the hash table is valid.`
`1993`	`1994`	`*`
`1994`	`1995`	`* The hash table becomes invalid if the hash value of a key`
`1995`	`1996`	`* has changed after the entry was created.`