Permalink
Browse files

* array.c: Documentation: change => in call-seq to ->.

            Harmonize "#=>" in examples. [ruby-core:30206]

* bignum.c: ditto

* class.c: ditto

* compar.c: ditto

* cont.c: ditto

* dir.c: ditto

* encoding.c: ditto

* enum.c: ditto

* enumerator.c: ditto

* error.c: ditto

* eval.c: ditto

* file.c: ditto

* gc.c: ditto

* io.c: ditto

* load.c: ditto

* marshal.c: ditto

* math.c: ditto

* numeric.c: ditto

* object.c: ditto

* pack.c: ditto

* proc.c: ditto

* process.c: ditto

* random.c: ditto

* range.c: ditto

* re.c: ditto

* ruby.c: ditto

* signal.c: ditto

* sprintf.c: ditto

* string.c: ditto

* struct.c: ditto

* thread.c: ditto

* time.c: ditto

* transcode.c: ditto

* variable.c: ditto

* vm_eval.c: ditto

* vm_method.c: ditto

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27865 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
  • Loading branch information...
1 parent 4a0ace5 commit 494ee476ca20cdd6396148b4a546c04d71f17b16 @marcandre marcandre committed May 17, 2010
Showing with 1,335 additions and 1,335 deletions.
  1. +14 −14 array.c
  2. +22 −22 bignum.c
  3. +6 −6 class.c
  4. +6 −6 compar.c
  5. +1 −1 cont.c
  6. +33 −33 dir.c
  7. +37 −37 encoding.c
  8. +85 −85 enum.c
  9. +8 −8 enumerator.c
  10. +22 −22 error.c
  11. +9 −9 eval.c
  12. +101 −101 file.c
  13. +16 −16 gc.c
  14. +213 −213 io.c
  15. +8 −8 load.c
  16. +3 −3 marshal.c
  17. +26 −26 math.c
  18. +3 −3 numeric.c
  19. +75 −75 object.c
  20. +1 −1 pack.c
  21. +70 −70 proc.c
  22. +91 −91 process.c
  23. +6 −6 random.c
  24. +27 −27 range.c
  25. +47 −47 re.c
  26. +7 −7 ruby.c
  27. +7 −7 signal.c
  28. +2 −2 sprintf.c
  29. +163 −163 string.c
  30. +24 −24 struct.c
  31. +51 −51 thread.c
  32. +93 −93 time.c
  33. +9 −9 transcode.c
  34. +14 −14 variable.c
  35. +17 −17 vm_eval.c
  36. +18 −18 vm_method.c
View
@@ -479,8 +479,8 @@ rb_check_array_type(VALUE ary)
* for any reason. This method can be used to check if an argument is an
* array.
*
- * Array.try_convert([1]) # => [1]
- * Array.try_convert("1") # => nil
+ * Array.try_convert([1]) #=> [1]
+ * Array.try_convert("1") #=> nil
*
* if tmp = Array.try_convert(arg)
* # the argument is an array
@@ -3559,9 +3559,9 @@ rb_ary_compact(VALUE ary)
* given, counts the number of elements yielding a true value.
*
* ary = [1, 2, 4, 2]
- * ary.count # => 4
- * ary.count(2) # => 2
- * ary.count{|x|x%2==0} # => 3
+ * ary.count #=> 4
+ * ary.count(2) #=> 2
+ * ary.count{|x|x%2==0} #=> 3
*
*/
@@ -4282,12 +4282,12 @@ rb_ary_repeated_combination(VALUE ary, VALUE num)
* and return +self+ instead.
*
*
- * [1,2,3].product([4,5]) # => [[1,4],[1,5],[2,4],[2,5],[3,4],[3,5]]
- * [1,2].product([1,2]) # => [[1,1],[1,2],[2,1],[2,2]]
- * [1,2].product([3,4],[5,6]) # => [[1,3,5],[1,3,6],[1,4,5],[1,4,6],
+ * [1,2,3].product([4,5]) #=> [[1,4],[1,5],[2,4],[2,5],[3,4],[3,5]]
+ * [1,2].product([1,2]) #=> [[1,1],[1,2],[2,1],[2,2]]
+ * [1,2].product([3,4],[5,6]) #=> [[1,3,5],[1,3,6],[1,4,5],[1,4,6],
* # [2,3,5],[2,3,6],[2,4,5],[2,4,6]]
- * [1,2].product() # => [[1],[2]]
- * [1,2].product([]) # => []
+ * [1,2].product() #=> [[1],[2]]
+ * [1,2].product([]) #=> []
*/
static VALUE
@@ -4381,7 +4381,7 @@ rb_ary_product(int argc, VALUE *argv, VALUE ary)
* Returns first n elements from <i>ary</i>.
*
* a = [1, 2, 3, 4, 5, 0]
- * a.take(3) # => [1, 2, 3]
+ * a.take(3) #=> [1, 2, 3]
*
*/
@@ -4406,7 +4406,7 @@ rb_ary_take(VALUE obj, VALUE n)
* If no block is given, an enumerator is returned instead.
*
* a = [1, 2, 3, 4, 5, 0]
- * a.take_while {|i| i < 3 } # => [1, 2]
+ * a.take_while {|i| i < 3 } #=> [1, 2]
*
*/
@@ -4430,7 +4430,7 @@ rb_ary_take_while(VALUE ary)
* in an array.
*
* a = [1, 2, 3, 4, 5, 0]
- * a.drop(3) # => [4, 5, 0]
+ * a.drop(3) #=> [4, 5, 0]
*
*/
@@ -4460,7 +4460,7 @@ rb_ary_drop(VALUE ary, VALUE n)
* If no block is given, an enumerator is returned instead.
*
* a = [1, 2, 3, 4, 5, 0]
- * a.drop_while {|i| i < 3 } # => [3, 4, 5, 0]
+ * a.drop_while {|i| i < 3 } #=> [3, 4, 5, 0]
*
*/
View
@@ -1112,7 +1112,7 @@ rb_big2str(VALUE x, int base)
/*
* call-seq:
- * big.to_s(base=10) => string
+ * big.to_s(base=10) -> string
*
* Returns a string containing the representation of <i>big</i> radix
* <i>base</i> (2 through 36).
@@ -1382,7 +1382,7 @@ rb_big_to_f(VALUE x)
/*
* call-seq:
- * big <=> numeric => -1, 0, +1 or nil
+ * big <=> numeric -> -1, 0, +1 or nil
*
* Comparison---Returns -1, 0, or +1 depending on whether <i>big</i> is
* less than, equal to, or greater than <i>numeric</i>. This is the
@@ -1543,7 +1543,7 @@ big_le(VALUE x, VALUE y)
/*
* call-seq:
- * big == obj => true or false
+ * big == obj -> true or false
*
* Returns <code>true</code> only if <i>obj</i> has the same value
* as <i>big</i>. Contrast this with <code>Bignum#eql?</code>, which
@@ -1581,7 +1581,7 @@ rb_big_eq(VALUE x, VALUE y)
/*
* call-seq:
- * big.eql?(obj) => true or false
+ * big.eql?(obj) -> true or false
*
* Returns <code>true</code> only if <i>obj</i> is a
* <code>Bignum</code> with the same value as <i>big</i>. Contrast this
@@ -1602,7 +1602,7 @@ rb_big_eql(VALUE x, VALUE y)
/*
* call-seq:
- * -big => integer
+ * -big -> integer
*
* Unary minus (returns an integer whose value is 0-big)
*/
@@ -1619,7 +1619,7 @@ rb_big_uminus(VALUE x)
/*
* call-seq:
- * ~big => integer
+ * ~big -> integer
*
* Inverts the bits in big. As Bignums are conceptually infinite
* length, the result acts as if it had an infinite number of one
@@ -1876,7 +1876,7 @@ bigadd(VALUE x, VALUE y, int sign)
/*
* call-seq:
- * big + other => Numeric
+ * big + other -> Numeric
*
* Adds big and other, returning the result.
*/
@@ -1913,7 +1913,7 @@ rb_big_plus(VALUE x, VALUE y)
/*
* call-seq:
- * big - other => Numeric
+ * big - other -> Numeric
*
* Subtracts other from big, returning the result.
*/
@@ -2273,7 +2273,7 @@ bigmul0(VALUE x, VALUE y)
/*
* call-seq:
- * big * other => Numeric
+ * big * other -> Numeric
*
* Multiplies big and other, returning the result.
*/
@@ -2522,7 +2522,7 @@ rb_big_divide(VALUE x, VALUE y, ID op)
/*
* call-seq:
- * big / other => Numeric
+ * big / other -> Numeric
*
* Performs division: the class of the resulting object depends on
* the class of <code>numeric</code> and on the magnitude of the
@@ -2537,7 +2537,7 @@ rb_big_div(VALUE x, VALUE y)
/*
* call-seq:
- * big.div(other) => integer
+ * big.div(other) -> integer
*
* Performs integer division: returns integer value.
*/
@@ -2550,8 +2550,8 @@ rb_big_idiv(VALUE x, VALUE y)
/*
* call-seq:
- * big % other => Numeric
- * big.modulo(other) => Numeric
+ * big % other -> Numeric
+ * big.modulo(other) -> Numeric
*
* Returns big modulo other. See Numeric.divmod for more
* information.
@@ -2580,7 +2580,7 @@ rb_big_modulo(VALUE x, VALUE y)
/*
* call-seq:
- * big.remainder(numeric) => number
+ * big.remainder(numeric) -> number
*
* Returns the remainder after dividing <i>big</i> by <i>numeric</i>.
*
@@ -2610,7 +2610,7 @@ rb_big_remainder(VALUE x, VALUE y)
/*
* call-seq:
- * big.divmod(numeric) => array
+ * big.divmod(numeric) -> array
*
* See <code>Numeric#divmod</code>.
*
@@ -2770,7 +2770,7 @@ bigsqr(VALUE x)
/*
* call-seq:
- * big ** exponent => numeric
+ * big ** exponent -> numeric
*
* Raises _big_ to the _exponent_ power (which may be an integer, float,
* or anything that will coerce to a number). The result may be
@@ -2891,7 +2891,7 @@ bigand_int(VALUE x, long y)
/*
* call-seq:
- * big & numeric => integer
+ * big & numeric -> integer
*
* Performs bitwise +and+ between _big_ and _numeric_.
*/
@@ -2982,7 +2982,7 @@ bigor_int(VALUE x, long y)
/*
* call-seq:
- * big | numeric => integer
+ * big | numeric -> integer
*
* Performs bitwise +or+ between _big_ and _numeric_.
*/
@@ -3073,7 +3073,7 @@ bigxor_int(VALUE x, long y)
}
/*
* call-seq:
- * big ^ numeric => integer
+ * big ^ numeric -> integer
*
* Performs bitwise +exclusive or+ between _big_ and _numeric_.
*/
@@ -3143,7 +3143,7 @@ check_shiftdown(VALUE y, VALUE x)
/*
* call-seq:
- * big << numeric => integer
+ * big << numeric -> integer
*
* Shifts big left _numeric_ positions (right if _numeric_ is negative).
*/
@@ -3207,7 +3207,7 @@ big_lshift(VALUE x, unsigned long shift)
/*
* call-seq:
- * big >> numeric => integer
+ * big >> numeric -> integer
*
* Shifts big right _numeric_ positions (left if _numeric_ is negative).
*/
@@ -3351,7 +3351,7 @@ rb_big_aref(VALUE x, VALUE y)
/*
* call-seq:
- * big.hash => fixnum
+ * big.hash -> fixnum
*
* Compute a hash based on the value of _big_.
*/
View
@@ -698,7 +698,7 @@ rb_mod_included_modules(VALUE mod)
/*
* call-seq:
- * mod.include?(module) => true or false
+ * mod.include?(module) -> true or false
*
* Returns <code>true</code> if <i>module</i> is included in
* <i>mod</i> or one of <i>mod</i>'s ancestors.
@@ -863,7 +863,7 @@ class_instance_method_list(int argc, VALUE *argv, VALUE mod, int (*func) (ID, lo
/*
* call-seq:
- * mod.instance_methods(include_super=true) => array
+ * mod.instance_methods(include_super=true) -> array
*
* Returns an array containing the names of instance methods that is callable
* from outside in the receiver. For a module, these are the public methods;
@@ -896,7 +896,7 @@ rb_class_instance_methods(int argc, VALUE *argv, VALUE mod)
/*
* call-seq:
- * mod.protected_instance_methods(include_super=true) => array
+ * mod.protected_instance_methods(include_super=true) -> array
*
* Returns a list of the protected instance methods defined in
* <i>mod</i>. If the optional parameter is not <code>false</code>, the
@@ -911,7 +911,7 @@ rb_class_protected_instance_methods(int argc, VALUE *argv, VALUE mod)
/*
* call-seq:
- * mod.private_instance_methods(include_super=true) => array
+ * mod.private_instance_methods(include_super=true) -> array
*
* Returns a list of the private instance methods defined in
* <i>mod</i>. If the optional parameter is not <code>false</code>, the
@@ -934,7 +934,7 @@ rb_class_private_instance_methods(int argc, VALUE *argv, VALUE mod)
/*
* call-seq:
- * mod.public_instance_methods(include_super=true) => array
+ * mod.public_instance_methods(include_super=true) -> array
*
* Returns a list of the public instance methods defined in <i>mod</i>.
* If the optional parameter is not <code>false</code>, the methods of
@@ -949,7 +949,7 @@ rb_class_public_instance_methods(int argc, VALUE *argv, VALUE mod)
/*
* call-seq:
- * obj.singleton_methods(all=true) => array
+ * obj.singleton_methods(all=true) -> array
*
* Returns an array of the names of singleton methods for <i>obj</i>.
* If the optional <i>all</i> parameter is true, the list will include
View
@@ -49,7 +49,7 @@ cmp_failed(void)
/*
* call-seq:
- * obj == other => true or false
+ * obj == other -> true or false
*
* Compares two objects based on the receiver's <code><=></code>
* method, returning true if it returns 0. Also returns true if
@@ -69,7 +69,7 @@ cmp_equal(VALUE x, VALUE y)
/*
* call-seq:
- * obj > other => true or false
+ * obj > other -> true or false
*
* Compares two objects based on the receiver's <code><=></code>
* method, returning true if it returns 1.
@@ -86,7 +86,7 @@ cmp_gt(VALUE x, VALUE y)
/*
* call-seq:
- * obj >= other => true or false
+ * obj >= other -> true or false
*
* Compares two objects based on the receiver's <code><=></code>
* method, returning true if it returns 0 or 1.
@@ -103,7 +103,7 @@ cmp_ge(VALUE x, VALUE y)
/*
* call-seq:
- * obj < other => true or false
+ * obj < other -> true or false
*
* Compares two objects based on the receiver's <code><=></code>
* method, returning true if it returns -1.
@@ -120,7 +120,7 @@ cmp_lt(VALUE x, VALUE y)
/*
* call-seq:
- * obj <= other => true or false
+ * obj <= other -> true or false
*
* Compares two objects based on the receiver's <code><=></code>
* method, returning true if it returns -1 or 0.
@@ -137,7 +137,7 @@ cmp_le(VALUE x, VALUE y)
/*
* call-seq:
- * obj.between?(min, max) => true or false
+ * obj.between?(min, max) -> true or false
*
* Returns <code>false</code> if <i>obj</i> <code><=></code>
* <i>min</i> is less than zero or if <i>anObject</i> <code><=></code>
View
@@ -806,7 +806,7 @@ cont_restore_0(rb_context_t *cont, VALUE *addr_in_prev_frame)
/*
* call-seq:
- * callcc {|cont| block } => obj
+ * callcc {|cont| block } -> obj
*
* Generates a <code>Continuation</code> object, which it passes to the
* associated block. Performing a <em>cont</em><code>.call</code> will
Oops, something went wrong.

0 comments on commit 494ee47

Please sign in to comment.