[DOC] Fix return value of rb_str_hash_cmp

peterzhu2118 · peterzhu2118 · commit 7913aff2b34b · 2025-07-28T09:34:25.000-04:00
rb_str_hash_cmp returns 0 if the two strings are identical and 1 if they
are different.
diff --git a/include/ruby/internal/intern/string.h b/include/ruby/internal/intern/string.h
@@ -970,8 +970,8 @@ st_index_t rb_str_hash(VALUE str);
  *
  * @param[in]  str1  A string.
  * @param[in]  str2  Another string.
- * @retval     1     They have identical contents, length, and encodings.
- * @retval     0     Otherwise.
+ * @retval     0     They have identical contents, length, and encodings.
+ * @retval     1     Otherwise.
  * @pre        Both   objects   must  not  be  any   arbitrary  objects  except
  *             ::RString.
  *

Original file line number	Diff line number	Diff line change
`@@ -970,8 +970,8 @@ st_index_t rb_str_hash(VALUE str);`
`970`	`970`	`*`
`971`	`971`	`* @param[in] str1 A string.`
`972`	`972`	`* @param[in] str2 Another string.`
`973`		`- * @retval 1 They have identical contents, length, and encodings.`
`974`		`- * @retval 0 Otherwise.`
	`973`	`+ * @retval 0 They have identical contents, length, and encodings.`
	`974`	`+ * @retval 1 Otherwise.`
`975`	`975`	`* @pre Both objects must not be any arbitrary objects except`
`976`	`976`	`* ::RString.`
`977`	`977`	`*`