[DOC] Tweaks for String#each_grapheme_cluster (#13981)

BurdetteLamar · web-flow · commit 56572baa4cd3 · 2025-07-23T17:07:25.000-04:00
diff --git a/doc/string/each_grapheme_cluster.rdoc b/doc/string/each_grapheme_cluster.rdoc
@@ -1,12 +1,25 @@
-Calls the given block with each successive grapheme cluster from +self+
+With a block given, calls the given block with each successive grapheme cluster from +self+
 (see {Unicode Grapheme Cluster Boundaries}[https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries]);
 returns +self+:
 
-  s = "\u0061\u0308-pqr-\u0062\u0308-xyz-\u0063\u0308" # => "ä-pqr-b̈-xyz-c̈"
-  s.each_grapheme_cluster {|gc| print gc, ' ' }
+  a = []
+  'hello'.each_grapheme_cluster do |grapheme_cluster|
+    a.push(grapheme_cluster)
+  end
+  a  # => ["h", "e", "l", "l", "o"]
 
-Output:
+  a = []
+  'тест'.each_grapheme_cluster do |grapheme_cluster|
+    a.push(grapheme_cluster)
+  end
+  a # => ["т", "е", "с", "т"]
 
-  ä - p q r - b̈ - x y z - c̈
+  a = []
+  'こんにちは'.each_grapheme_cluster do |grapheme_cluster|
+    a.push(grapheme_cluster)
+  end
+  a # => ["こ", "ん", "に", "ち", "は"]
 
-Returns an enumerator if no block is given.
+With no block given, returns an enumerator.
+
+Related: see {Iterating}[rdoc-ref:String@Iterating].
diff --git a/string.c b/string.c
@@ -10029,7 +10029,7 @@ rb_str_enumerate_grapheme_clusters(VALUE str, VALUE ary)
 
 /*
  *  call-seq:
- *    each_grapheme_cluster {|gc| ... } -> self
+ *    each_grapheme_cluster {|grapheme_cluster| ... } -> self
  *    each_grapheme_cluster             -> enumerator
  *
  *  :include: doc/string/each_grapheme_cluster.rdoc

Original file line number	Diff line number	Diff line change
`@@ -10029,7 +10029,7 @@ rb_str_enumerate_grapheme_clusters(VALUE str, VALUE ary)`
`10029`	`10029`
`10030`	`10030`	`/*`
`10031`	`10031`	`* call-seq:`
`10032`		`- * each_grapheme_cluster {\|gc\| ... } -> self`
	`10032`	`+ * each_grapheme_cluster {\|grapheme_cluster\| ... } -> self`
`10033`	`10033`	`* each_grapheme_cluster -> enumerator`
`10034`	`10034`	`*`
`10035`	`10035`	`* :include: doc/string/each_grapheme_cluster.rdoc`