summaryrefslogtreecommitdiff
path: root/doc/string/grapheme_clusters.rdoc
diff options
context:
space:
mode:
authorBurdette Lamar <BurdetteLamar@Yahoo.com>2022-03-22 14:51:05 -0500
committerGitHub <noreply@github.com>2022-03-22 14:51:05 -0500
commit0140e6c41e4669e157c5a99b9d4b5b0fa153359b (patch)
tree0a8e557ad39cd70d2135734c8e91ddeecfdcb1d1 /doc/string/grapheme_clusters.rdoc
parent26aff37466fa3226122c65f49f2b7663e6b2551b (diff)
downloadruby-0140e6c41e4669e157c5a99b9d4b5b0fa153359b.tar.gz
[DOC] Enhanced RDoc for String (#5685)
Treats: #chars #codepoints #each_char #each_codepoint #each_grapheme_cluster #grapheme_clusters Also, corrects a passage in #unicode_normalize that mentioned module UnicodeNormalize, whose doc (:nodoc:, actually) says not to mention it.
Diffstat (limited to 'doc/string/grapheme_clusters.rdoc')
-rw-r--r--doc/string/grapheme_clusters.rdoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/string/grapheme_clusters.rdoc b/doc/string/grapheme_clusters.rdoc
new file mode 100644
index 0000000000..8c7f5a7259
--- /dev/null
+++ b/doc/string/grapheme_clusters.rdoc
@@ -0,0 +1,6 @@
+Returns an array of the grapheme clusters in +self+
+(see {Unicode Grapheme Cluster Boundaries}[https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries]):
+
+ s = "\u0061\u0308-pqr-\u0062\u0308-xyz-\u0063\u0308" # => "ä-pqr-b̈-xyz-c̈"
+ s.grapheme_clusters
+ # => ["ä", "-", "p", "q", "r", "-", "b̈", "-", "x", "y", "z", "-", "c̈"]