From 7729de4d91ffbf0fe8fa4f2a95b85d3406845471 Mon Sep 17 00:00:00 2001 From: marcandre Date: Mon, 17 May 2010 21:07:33 +0000 Subject: * 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 --- range.c | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'range.c') diff --git a/range.c b/range.c index ca9052e621..1866df1507 100644 --- a/range.c +++ b/range.c @@ -69,7 +69,7 @@ rb_range_new(VALUE beg, VALUE end, int exclude_end) /* * call-seq: - * Range.new(start, end, exclusive=false) => range + * Range.new(start, end, exclusive=false) -> range * * Constructs a range using the given start and end. If the third * parameter is omitted or is false, the range will include @@ -94,7 +94,7 @@ range_initialize(int argc, VALUE *argv, VALUE range) /* * call-seq: - * rng.exclude_end? => true or false + * rng.exclude_end? -> true or false * * Returns true if rng excludes its end value. */ @@ -122,7 +122,7 @@ recursive_equal(VALUE range, VALUE obj, int recur) /* * call-seq: - * rng == obj => true or false + * rng == obj -> true or false * * Returns true only if obj is a Range, has equivalent * beginning and end items (by comparing them with ==), and has @@ -190,7 +190,7 @@ recursive_eql(VALUE range, VALUE obj, int recur) /* * call-seq: - * rng.eql?(obj) => true or false + * rng.eql?(obj) -> true or false * * Returns true only if obj is a Range, has equivalent * beginning and end items (by comparing them with #eql?), and has the same @@ -233,7 +233,7 @@ recursive_hash(VALUE range, VALUE dummy, int recur) /* * call-seq: - * rng.hash => fixnum + * rng.hash -> fixnum * * Generate a hash value such that two ranges with the same start and * end points, and the same value for the "exclude end" flag, generate @@ -318,8 +318,8 @@ discrete_object_p(VALUE obj) /* * call-seq: - * rng.step(n=1) {| obj | block } => rng - * rng.step(n=1) => an_enumerator + * rng.step(n=1) {| obj | block } -> rng + * rng.step(n=1) -> an_enumerator * * Iterates over rng, passing each nth element to the block. If * the range contains numbers, n is added for each iteration. Otherwise @@ -455,8 +455,8 @@ sym_each_i(VALUE v, void *arg) /* * call-seq: - * rng.each {| i | block } => rng - * rng.each => an_enumerator + * rng.each {| i | block } -> rng + * rng.each -> an_enumerator * * Iterates over the elements rng, passing each in turn to the * block. You can only iterate if the start object of the range @@ -524,7 +524,7 @@ range_each(VALUE range) /* * call-seq: - * rng.begin => obj + * rng.begin -> obj * * Returns the first object in rng. */ @@ -538,7 +538,7 @@ range_begin(VALUE range) /* * call-seq: - * rng.end => obj + * rng.end -> obj * * Returns the object that defines the end of rng. * @@ -570,8 +570,8 @@ first_i(VALUE i, VALUE *ary) /* * call-seq: - * rng.first => obj - * rng.first(n) => an_array + * rng.first -> obj + * rng.first(n) -> an_array * * Returns the first object in rng, or the first +n+ elements. */ @@ -594,8 +594,8 @@ range_first(int argc, VALUE *argv, VALUE range) /* * call-seq: - * rng.last => obj - * rng.last(n) => an_array + * rng.last -> obj + * rng.last(n) -> an_array * * Returns the last object in rng, or the last +n+ elements. */ @@ -612,8 +612,8 @@ range_last(int argc, VALUE *argv, VALUE range) /* * call-seq: - * rng.min => obj - * rng.min {| a,b | block } => obj + * rng.min -> obj + * rng.min {| a,b | block } -> obj * * Returns the minimum value in rng. The second uses * the block to compare values. Returns nil if the first @@ -641,8 +641,8 @@ range_min(VALUE range) /* * call-seq: - * rng.max => obj - * rng.max {| a,b | block } => obj + * rng.max -> obj + * rng.max {| a,b | block } -> obj * * Returns the maximum value in rng. The second uses * the block to compare values. Returns nil if the first @@ -749,7 +749,7 @@ rb_range_beg_len(VALUE range, long *begp, long *lenp, long len, int err) /* * call-seq: - * rng.to_s => string + * rng.to_s -> string * * Convert this range object to a printable form. */ @@ -789,7 +789,7 @@ inspect_range(VALUE range, VALUE dummy, int recur) /* * call-seq: - * rng.inspect => string + * rng.inspect -> string * * Convert this range object to a printable form (using * inspect to convert the start and end @@ -805,7 +805,7 @@ range_inspect(VALUE range) /* * call-seq: - * rng === obj => true or false + * rng === obj -> true or false * * Returns true if obj is an element of * rng, false otherwise. Conveniently, @@ -832,15 +832,15 @@ range_eqq(VALUE range, VALUE val) /* * call-seq: - * rng.member?(val) => true or false - * rng.include?(val) => true or false + * rng.member?(val) -> true or false + * rng.include?(val) -> true or false * * Returns true if obj is an element of * rng, false otherwise. If beg and end are * numeric, comparison is done according magnitude of values. * - * ("a".."z").include?("g") # => true - * ("a".."z").include?("A") # => false + * ("a".."z").include?("g") # -> true + * ("a".."z").include?("A") # -> false */ static VALUE @@ -893,7 +893,7 @@ range_include(VALUE range, VALUE val) /* * call-seq: - * rng.cover?(val) => true or false + * rng.cover?(val) -> true or false * * Returns true if obj is between beg and end, * i.e beg <= obj <= end (or end exclusive when -- cgit v1.2.3