summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormrkn <mrkn@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-09-12 08:51:34 +0000
committermrkn <mrkn@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-09-12 08:51:34 +0000
commit98fa0ab4d955cf275ceb15573a5d40edd2e82522 (patch)
tree79aa018e750ae1bf589aee9b4ec5e2947e3698ff
parent1595421ce0ab3cc943a22e7fef6a2294540fff20 (diff)
[DOC] Modify descriptions for ArithmeticSequence
[ci-skip] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@64697 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--numeric.c6
-rw-r--r--range.c3
2 files changed, 8 insertions, 1 deletions
diff --git a/numeric.c b/numeric.c
index ef724919874..da0bad32110 100644
--- a/numeric.c
+++ b/numeric.c
@@ -2654,9 +2654,11 @@ num_step_size(VALUE from, VALUE args, VALUE eobj)
/*
* call-seq:
* num.step(by: step, to: limit) {|i| block } -> self
- * num.step(by: step, to: limit) -> an_enumerator
+ * num.step(by: step, to: limit) -> an_enumerator
+ * num.step(by: step, to: limit) -> an_arithmetic_sequence
* num.step(limit=nil, step=1) {|i| block } -> self
* num.step(limit=nil, step=1) -> an_enumerator
+ * num.step(limit=nil, step=1) -> an_arithmetic_sequence
*
* Invokes the given block with the sequence of numbers starting at +num+,
* incremented by +step+ (defaulted to +1+) on each call.
@@ -2685,6 +2687,8 @@ num_step_size(VALUE from, VALUE args, VALUE eobj)
* and increments itself using the <code>+</code> operator.
*
* If no block is given, an Enumerator is returned instead.
+ * Especially, the enumerator is an Enumerator::ArithmeticSequence
+ * if both +limit+ and +step+ are kind of Numeric or <code>nil</code>.
*
* For example:
*
diff --git a/range.c b/range.c
index 2763b323ebe..d781af3f2e5 100644
--- a/range.c
+++ b/range.c
@@ -353,6 +353,7 @@ range_step_size(VALUE range, VALUE args, VALUE eobj)
* call-seq:
* rng.step(n=1) {| obj | block } -> rng
* rng.step(n=1) -> an_enumerator
+ * rng.step(n=1) -> an_arithmetic_sequence
*
* Iterates over the range, passing each <code>n</code>th element to the block.
* If begin and end are numeric, +n+ is added for each iteration.
@@ -360,6 +361,8 @@ range_step_size(VALUE range, VALUE args, VALUE eobj)
* range elements.
*
* If no block is given, an enumerator is returned instead.
+ * Especially, the enumerator is an Enumerator::ArithmeticSequence
+ * if begin and end of the range are numeric.
*
* range = Xs.new(1)..Xs.new(10)
* range.step(2) {|x| puts x}