Skip to content

Commit f9a2802

Browse files
peterzhu2118peterzhu2118
committed
[DOC] Use RDoc link style for links to other classes/modules
I used this regex: ([A-Za-z]+)\.html#(?:class|module)-[A-Za-z]+-label-([A-Za-z0-9\-\+]+) And performed a global find & replace for this: rdoc-ref:$1@$2
1 parent ecd469f commit f9a2802

File tree

9 files changed

+29
-29
lines changed

9 files changed

+29
-29
lines changed

‎array.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8080,8 +8080,8 @@ rb_ary_deconstruct(VALUE ary)
80808080
*
80818081
* First, what's elsewhere. \Class \Array:
80828082
*
8083-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
8084-
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
8083+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
8084+
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
80858085
* which provides dozens of additional methods.
80868086
*
80878087
* Here, class \Array provides methods that are useful for:

‎file.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6577,9 +6577,9 @@ const char ruby_null_device[] =
65776577
*
65786578
* First, what's elsewhere. \Class \File:
65796579
*
6580-
* - Inherits from {class IO}[IO.html#class-IO-label-What-27s+Here],
6580+
* - Inherits from {class IO}[rdoc-ref:IO@What-27s+Here],
65816581
* in particular, methods for creating, reading, and writing files
6582-
* - Includes {module FileTest}[FileTest.html#module-FileTest-label-What-27s+Here].
6582+
* - Includes {module FileTest}[rdoc-ref:FileTest@What-27s+Here].
65836583
* which provides dozens of additional methods.
65846584
*
65856585
* Here, class \File provides methods that are useful for:

‎hash.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7014,8 +7014,8 @@ static const rb_data_type_t env_data_type = {
70147014
*
70157015
* First, what's elsewhere. \Class \Hash:
70167016
*
7017-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
7018-
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
7017+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
7018+
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
70197019
* which provides dozens of additional methods.
70207020
*
70217021
* Here, class \Hash provides methods that are useful for:
@@ -7327,8 +7327,8 @@ Init_Hash(void)
73277327
*
73287328
* First, what's elsewhere. \Class \ENV:
73297329
*
7330-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
7331-
* - Extends {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
7330+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
7331+
* - Extends {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
73327332
*
73337333
* Here, class \ENV provides methods that are useful for:
73347334
*

‎io.c

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9715,12 +9715,12 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
97159715
*
97169716
* Returns an array containing the lines returned by calling
97179717
* Kernel#gets until the end-of-file is reached;
9718-
* (see {Lines}[IO.html#class-IO-label-Lines]).
9718+
* (see {Lines}[rdoc-ref:IO@Lines]).
97199719
*
97209720
* With only string argument +sep+ given,
97219721
* returns the remaining lines as determined by line separator +sep+,
97229722
* or +nil+ if none;
9723-
* see {Line Separator}[IO.html#class-IO-label-Line+Separator].\:
9723+
* see {Line Separator}[rdoc-ref:IO@Line+Separator].\:
97249724
*
97259725
* # Default separator.
97269726
* $ cat t.txt | ruby -e "p readlines"
@@ -9740,7 +9740,7 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
97409740
*
97419741
* With only integer argument +limit+ given,
97429742
* limits the number of bytes in the line;
9743-
* see {Line Limit}}[IO.html#class-IO-label-Line+Limit]:
9743+
* see {Line Limit}}[rdoc-ref:IO@Line+Limit]:
97449744
*
97459745
* $cat t.txt | ruby -e "p readlines 10"
97469746
* ["First line", "\n", "Second lin", "e\n", "\n", "Fourth lin", "e\n", "Fifth line", "\n"]
@@ -9752,10 +9752,10 @@ static VALUE argf_readlines(int, VALUE *, VALUE);
97529752
* ["First line\n", "Second line\n", "\n", "Fourth line\n", "Fifth line\n"]
97539753
*
97549754
* With arguments +sep+ and +limit+ given, combines the two behaviors;
9755-
* see {Line Separator and Line Limit}[IO.html#class-IO-label-Line+Separator+and+Line+Limit].
9755+
* see {Line Separator and Line Limit}[rdoc-ref:IO@Line+Separator+and+Line+Limit].
97569756
*
97579757
* For all forms above, trailing optional keyword arguments may be given;
9758-
* see {Line Options}[IO.html#class-IO-label-Line+Options]:
9758+
* see {Line Options}[rdoc-ref:IO@Line+Options]:
97599759
*
97609760
* $ cat t.txt | ruby -e "p readlines(chomp: true)"
97619761
* ["First line", "Second line", "", "Fourth line", "Fifth line"]
@@ -14376,8 +14376,8 @@ set_LAST_READ_LINE(VALUE val, ID _x, VALUE *_y)
1437614376
*
1437714377
* First, what's elsewhere. \Class \IO:
1437814378
*
14379-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
14380-
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
14379+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
14380+
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
1438114381
* which provides dozens of additional methods.
1438214382
*
1438314383
* Here, class \IO provides methods that are useful for:

‎numeric.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -958,7 +958,7 @@ num_negative_p(VALUE num)
958958
*
959959
* First, what's elsewhere. \Class \Float:
960960
*
961-
* - Inherits from {class Numeric}[Numeric.html#class-Numeric-label-What-27s+Here].
961+
* - Inherits from {class Numeric}[rdoc-ref:Numeric@What-27s+Here].
962962
*
963963
* Here, class \Float provides methods for:
964964
*
@@ -3495,7 +3495,7 @@ rb_num2ull(VALUE val)
34953495
*
34963496
* First, what's elsewhere. \Class \Integer:
34973497
*
3498-
* - Inherits from {class Numeric}[Numeric.html#class-Numeric-label-What-27s+Here].
3498+
* - Inherits from {class Numeric}[rdoc-ref:Numeric@What-27s+Here].
34993499
*
35003500
* Here, class \Integer provides methods for:
35013501
*
@@ -6099,8 +6099,8 @@ int_s_try_convert(VALUE self, VALUE num)
60996099
*
61006100
* First, what's elsewhere. \Class \Numeric:
61016101
*
6102-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
6103-
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
6102+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
6103+
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
61046104
*
61056105
* Here, class \Numeric provides methods for:
61066106
*

‎object.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4162,8 +4162,8 @@ f_sprintf(int c, const VALUE *v, VALUE _)
41624162
*
41634163
* First, what's elsewhere. \Class \Object:
41644164
*
4165-
* - Inherits from {class BasicObject}[BasicObject.html#class-BasicObject-label-What-27s+Here].
4166-
* - Includes {module Kernel}[Kernel.html#module-Kernel-label-What-27s+Here].
4165+
* - Inherits from {class BasicObject}[rdoc-ref:BasicObject@What-27s+Here].
4166+
* - Includes {module Kernel}[rdoc-ref:Kernel@What-27s+Here].
41674167
*
41684168
* Here, class \Object provides methods for:
41694169
*

‎range.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2207,8 +2207,8 @@ range_count(int argc, VALUE *argv, VALUE range)
22072207
*
22082208
* First, what's elsewhere. \Class \Range:
22092209
*
2210-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
2211-
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
2210+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
2211+
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
22122212
* which provides dozens of additional methods.
22132213
*
22142214
* Here, class \Range provides methods that are useful for:

‎string.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11291,8 +11291,8 @@ rb_str_unicode_normalized_p(int argc, VALUE *argv, VALUE str)
1129111291
*
1129211292
* First, what's elsewhere. \Class \Symbol:
1129311293
*
11294-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
11295-
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
11294+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
11295+
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
1129611296
*
1129711297
* Here, class \Symbol provides methods that are useful for:
1129811298
*
@@ -12095,8 +12095,8 @@ rb_enc_interned_str_cstr(const char *ptr, rb_encoding *enc)
1209512095
*
1209612096
* First, what's elsewhere. \Class \String:
1209712097
*
12098-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
12099-
* - Includes {module Comparable}[Comparable.html#module-Comparable-label-What-27s+Here].
12098+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
12099+
* - Includes {module Comparable}[rdoc-ref:Comparable@What-27s+Here].
1210012100
*
1210112101
* Here, class \String provides methods that are useful for:
1210212102
*

‎struct.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,8 +1562,8 @@ rb_struct_dig(int argc, VALUE *argv, VALUE self)
15621562
*
15631563
* First, what's elsewhere. \Class \Struct:
15641564
*
1565-
* - Inherits from {class Object}[Object.html#class-Object-label-What-27s+Here].
1566-
* - Includes {module Enumerable}[Enumerable.html#module-Enumerable-label-What-27s+Here],
1565+
* - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
1566+
* - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
15671567
* which provides dozens of additional methods.
15681568
*
15691569
* Here, class \Struct provides methods that are useful for:

0 commit comments

Comments
 (0)