[前][次][番号順一覧][スレッド一覧]

ruby-changes:71549

From: Nobuyoshi <ko1@a...>
Date: Wed, 30 Mar 2022 11:00:21 +0900 (JST)
Subject: [ruby-changes:71549] 0bca029d2f (master): [DOC] Use simple references to operator methods

https://git.ruby-lang.org/ruby.git/commit/?id=0bca029d2f

From 0bca029d2f848cc326681d2c324712eec96808e8 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@r...>
Date: Sat, 26 Mar 2022 21:07:06 +0900
Subject: [DOC] Use simple references to operator methods

Method references is not only able to be marked up as code, also
reflects `--show-hash` option.
The bug that prevented the old rdoc from correctly parsing these
methods was fixed last month.
---
 compar.c | 12 ++++--------
 object.c |  8 ++++----
 2 files changed, 8 insertions(+), 12 deletions(-)

diff --git a/compar.c b/compar.c
index 6ee4c2c3fa..9f47a3fa62 100644
--- a/compar.c
+++ b/compar.c
@@ -288,15 +288,11 @@ cmp_clamp(int argc, VALUE *argv, VALUE x) https://github.com/ruby/ruby/blob/trunk/compar.c#L288
  *
  *  \Module \Comparable provides these methods, all of which use method <tt><=></tt>:
  *
- *  - {<}[Comparable.html#method-i-3C]:
- *    Returns whether +self+ is less than the given object.
- *  - {<=}[Comparable.html#method-i-3C-3D]:
- *    Returns whether +self+ is less than or equal to the given object.
+ *  - #<: Returns whether +self+ is less than the given object.
+ *  - #<=: Returns whether +self+ is less than or equal to the given object.
  *  - #==: Returns whether +self+ is equal to the given object.
- *  - {>}[Comparable.html#method-i-3E]:
- *    Returns whether +self+ is greater than or equal to the given object.
- *  - {>=}[Comparable.html#method-i-3E-3D]:
- *    Returns whether +self+ is greater than the given object.
+ *  - #>: Returns whether +self+ is greater than or equal to the given object.
+ *  - #>=: Returns whether +self+ is greater than the given object.
  *  - #between?: Returns +true+ if +self+ is between two given objects.
  *  - #clamp: For given objects +min+ and +max+, or range <tt>(min..max)</tt>, returns:
  *
diff --git a/object.c b/object.c
index 8d5ab63c9c..296dc68322 100644
--- a/object.c
+++ b/object.c
@@ -4195,8 +4195,8 @@ f_sprintf(int c, const VALUE *v, VALUE _) https://github.com/ruby/ruby/blob/trunk/object.c#L4195
  *  These are the methods defined for \BasicObject:
  *
  *  - ::new: Returns a new \BasicObject instance.
- *  - {!}[#method-i-21]: Returns the boolean negation of +self+: +true+ or +false+.
- *  - {!=}[#method-i-21-3D]: Returns whether +self+ and the given object are _not_ equal.
+ *  - #!: Returns the boolean negation of +self+: +true+ or +false+.
+ *  - #!=: Returns whether +self+ and the given object are _not_ equal.
  *  - #==: Returns whether +self+ and the given object are equivalent.
  *  - {__id__}[#method-i-__id__]: Returns the integer object identifier for +self+.
  *  - {__send__}[#method-i-__send__]: Calls the method identified by the given symbol.
@@ -4240,9 +4240,9 @@ f_sprintf(int c, const VALUE *v, VALUE _) https://github.com/ruby/ruby/blob/trunk/object.c#L4240
  *
  *  === Querying
  *
- *  - {!~}[#method-i-21~]: Returns +true+ if +self+ does not match the given object,
+ *  - #!~: Returns +true+ if +self+ does not match the given object,
  *    otherwise +false+.
- *  - {<=>}[#method-i-3C-3D-3E]: Returns 0 if +self+ and the given object +object+ are the same
+ *  - #<=>: Returns 0 if +self+ and the given object +object+ are the same
  *    object, or if <tt>self == object</tt>; otherwise returns +nil+.
  *  - #===: Implements case equality, effectively the same as calling #==.
  *  - #eql?: Implements hash equality, effectively the same as calling #==.
-- 
cgit v1.2.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]