Update documentation for each_* aliases

now · Apr 9, 2013 · d32f5ad · d32f5ad
1 parent 21cd9e6
commit d32f5ad
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/ext/u/rb_u_string.c b/ext/u/rb_u_string.c
@@ -261,8 +261,9 @@ rb_u_string_dup(VALUE self)
  * Beyond interrogators there are quite a few methods for iterating over the
  * content of a U::String, each viewing it in its own way: {#each_byte},
  * {#each_char}, {#each_codepoint}, {#each_grapheme_cluster}, {#each_line}, and
- * {#each_word}.  They all have aliases ({#bytes}, {#chars}, {#codepoints},
- * {#grapheme_clusters}, {#lines}, {#words}) that sometimes read better.
+ * {#each_word}.  They all have respective methods ({#bytes}, {#chars},
+ * {#codepoints}, {#grapheme_clusters}, {#lines}, {#words}) that return an
+ * Array instead of yielding each result.
  *
  * Quite a few methods are devoted to extracting a substring of a U::String,
  * namely {#[]}, {#slice}, {#byteslice}, {#chomp}, {#chop}, {#chr}, {#getbyte},

diff --git a/ext/u/rb_u_string_each_codepoint.c b/ext/u/rb_u_string_each_codepoint.c
@@ -35,7 +35,7 @@ rb_u_string_each_codepoint(VALUE self)
         return self;
 }
 
-/* @return [Array<U::String>] The code points of the receiver. */
+/* @return [Array<Integer>] The code points of the receiver. */
 VALUE
 rb_u_string_codepoints(VALUE self)
 {