diff options
author | marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-05-17 21:50:17 +0000 |
---|---|---|
committer | marcandre <marcandre@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-05-17 21:50:17 +0000 |
commit | c98396334f7bf980e5bed863d86022fc28f66e2d (patch) | |
tree | e4e24eb0748f6162d470e512833cb87e9058fbbd | |
parent | e2ee4678a1b1be108149beab0a85599c39464a91 (diff) |
* proc.c: Small documentation fixes.
* re.c: ditto
* string.c: ditto
* time.c: ditto
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_2@27872 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | proc.c | 9 | ||||
-rw-r--r-- | re.c | 4 | ||||
-rw-r--r-- | string.c | 2 | ||||
-rw-r--r-- | time.c | 10 |
4 files changed, 11 insertions, 14 deletions
@@ -528,10 +528,10 @@ proc_lambda(void) /* * call-seq: - * prc === obj -> obj + * prc === obj -> result_of_proc * * Invokes the block, with <i>obj</i> as the block's parameter. It is - * to allow a proc object to be a target of when clause in the case statement. + * to allow a proc object to be a target of +when+ clause in the case statement. */ static VALUE @@ -728,7 +728,10 @@ unnamed_parameters(int arity) * call-seq: * proc.parameters -> array * - * returns the parameter information of this proc + * returns the parameter information of this proc. + * + * prc = lambda{|x, y=42, *rest|} + * prc.parameters #=> [[:req, :x], [:opt, :y], [:rest, :rest]] */ static VALUE @@ -2836,9 +2836,9 @@ rb_reg_match_m(int argc, VALUE *argv, VALUE re) /* * call-seq: - * Regexp.new(string [, options] [, lang]) -> regexp + * Regexp.new(string, [options [, lang]]) -> regexp * Regexp.new(regexp) -> regexp - * Regexp.compile(string [, options] [, lang]) -> regexp + * Regexp.compile(string, [options [, lang]]) -> regexp * Regexp.compile(regexp) -> regexp * * Constructs a new regular expression from <i>pattern</i>, which can be either @@ -1399,7 +1399,7 @@ rb_check_string_type(VALUE str) * Returns converted string or nil if <i>obj</i> cannot be converted * for any reason. * - * String.try_convert("str") #=> str + * String.try_convert("str") #=> "str" * String.try_convert(/re/) #=> nil */ static VALUE @@ -2117,13 +2117,7 @@ time_init_1(int argc, VALUE *argv, VALUE time) /* * call-seq: * Time.new -> time - * Time.new(year) -> time - * Time.new(year, month) -> time - * Time.new(year, month, day) -> time - * Time.new(year, month, day, hour) -> time - * Time.new(year, month, day, hour, min) -> time - * Time.new(year, month, day, hour, min, sec) -> time - * Time.new(year, month, day, hour, min, sec, utc_offset) -> time + * Time.new(year, month=nil, day=nil, hour=nil, min=nil, sec=nil, utc_offset=nil) -> time * * Returns a <code>Time</code> object. * @@ -3089,7 +3083,7 @@ time_to_f(VALUE time) /* * call-seq: - * time.to_r -> Rational + * time.to_r -> a_rational * * Returns the value of <i>time</i> as a rational number of seconds * since the Epoch. |