From ed7a2cec81e4f14ba69722a873cc2aa25464e439 Mon Sep 17 00:00:00 2001 From: stomar Date: Thu, 4 May 2017 13:19:43 +0000 Subject: string.c: [DOC] improve docs for String.new git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58569 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- string.c | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) (limited to 'string.c') diff --git a/string.c b/string.c index 6839520575..eda2452716 100644 --- a/string.c +++ b/string.c @@ -1447,19 +1447,21 @@ rb_str_resurrect(VALUE str) /* * call-seq: - * String.new(str="") -> new_str - * String.new(str="", encoding: enc) -> new_str - * String.new(str="", capacity: size) -> new_str + * String.new(str="") -> new_str + * String.new(str="", encoding: enc) -> new_str + * String.new(str="", capacity: size) -> new_str * * Returns a new string object containing a copy of str. * - * The optional encoding argument specifies the encoding of the new string. - * If not specified, the encoding of str (or ASCII-8BIT, if str - * is not specified) is used. + * The optional encoding keyword argument specifies the encoding + * of the new string. + * If not specified, the encoding of str is used + * (or ASCII-8BIT, if str is not specified). * - * The optional capacity argument specifies the size of internal buffer. + * The optional capacity keyword argument specifies the size + * of the internal buffer. * This may improve performance, when the string will be concatenated many - * times (and call many realloc). + * times (causing many realloc calls). */ static VALUE -- cgit v1.2.3