From 8b1c1c55a92a0879f9a99bb48ff7b4b280f2bce0 Mon Sep 17 00:00:00 2001 From: stomar Date: Tue, 7 Nov 2017 20:15:59 +0000 Subject: string.c: improve docs for String#{concat,<<} * string.c: [DOC] remove a misleading call-seq for String#concat, which suggests that all arguments must be Integers in this case; also clarify in the example that the receiver is modified; fix grammar for String#<<; move references to the end. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60712 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- string.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'string.c') diff --git a/string.c b/string.c index c18441a86d..5731807379 100644 --- a/string.c +++ b/string.c @@ -2944,20 +2944,22 @@ rb_str_concat_literals(size_t num, const VALUE *strary) /* * call-seq: * str.concat(obj1, obj2,...) -> str - * str.concat(integer1, integer2,...) -> str * * Concatenates the given object(s) to str. If an object is an * Integer, it is considered a codepoint and converted * to a character before concatenation. * - * +concat+ can take multiple arguments, and all the arguments are concatenated - * in order. See String#<<, which takes a single argument. + * +concat+ can take multiple arguments, and all the arguments are + * concatenated in order. * * a = "hello " * a.concat("world", 33) #=> "hello world!" + * a #=> "hello world!" * * b = "sn" * b.concat("_", b, "_", b) #=> "sn_sn_sn" + * + * See also String#<<, which takes a single argument. */ static VALUE rb_str_concat_multi(int argc, VALUE *argv, VALUE str) @@ -2985,15 +2987,15 @@ rb_str_concat_multi(int argc, VALUE *argv, VALUE str) * str << obj -> str * str << integer -> str * - * Append the given object to str. If the object is an + * Appends the given object to str. If the object is an * Integer, it is considered a codepoint and converted * to a character before being appended. * - * See String#concat, which takes multiple arguments. - * * a = "hello " * a << "world" #=> "hello world" * a << 33 #=> "hello world!" + * + * See also String#concat, which takes multiple arguments. */ VALUE rb_str_concat(VALUE str1, VALUE str2) -- cgit v1.2.3