summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2019-10-15 22:38:39 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2019-10-15 22:38:39 +0900
commit81176095f45a5c9f14fc61dfce041735094f893f (patch)
treece6474187d0bedcdc485a64cbee8f7d7c5390f3e
parente0e93a199d28446a5d1b1289ee9466f7af01e62e (diff)
[DOC] fixed a variable name [ci skip]
replaced "anObject" with "obj". also marked up with simple `_`s instead of `<i>`.
-rw-r--r--compar.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/compar.c b/compar.c
index 3d06592..027328d 100644
--- a/compar.c
+++ b/compar.c
@@ -154,9 +154,9 @@ cmp_le(VALUE x, VALUE y)
* call-seq:
* 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>
- * <i>max</i> is greater than zero, <code>true</code> otherwise.
+ * Returns <code>false</code> if _obj_ <code><=></code> _min_ is less
+ * than zero or if _obj_ <code><=></code> _max_ is greater than zero,
+ * <code>true</code> otherwise.
*
* 3.between?(1, 5) #=> true
* 6.between?(1, 5) #=> false
@@ -177,9 +177,9 @@ cmp_between(VALUE x, VALUE min, VALUE max)
* call-seq:
* obj.clamp(min, max) -> obj
*
- * Returns <i>min</i> if <i>obj</i> <code><=></code> <i>min</i> is less
- * than zero, <i>max</i> if <i>obj</i> <code><=></code> <i>max</i> is
- * greater than zero and <i>obj</i> otherwise.
+ * Returns _min_ if _obj_ <code><=></code> _min_ is less than zero,
+ * _max_ if _obj_ <code><=></code> _max_ is greater than zero and
+ * _obj_ otherwise.
*
* 12.clamp(0, 100) #=> 12
* 523.clamp(0, 100) #=> 100