mirror/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-01-26 20:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Remove the name from same file references

Browse Source
This commit is contained in:
Nobuyoshi Nakada 2025-11-23 17:56:11 +09:00
parent beb85e7eee
commit fed528a995
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465
Notes: git 2025-11-23 09:06:06 +00:00 
Merged: https://github.com/ruby/ruby/pull/15304
6 changed files with 56 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/encodings.rdoc
View File

@ -138,7 +138,7 @@ A Ruby String object has an encoding that is an instance of class \Encoding.
The encoding may be retrieved by method String#encoding.
The default encoding for a string literal is the script encoding;
see {Script Encoding}[rdoc-ref:encodings.rdoc@Script+Encoding].
see {Script Encoding}[rdoc-ref:@Script+Encoding].
's'.encoding # => #<Encoding:UTF-8>
@ -147,7 +147,7 @@ The default encoding for a string created with method String.new is:
- For no argument, ASCII-8BIT.
- For a \String object argument, the encoding of that string.
- For a string literal, the script encoding;
see {Script Encoding}[rdoc-ref:encodings.rdoc@Script+Encoding].
see {Script Encoding}[rdoc-ref:@Script+Encoding].
In either case, any encoding may be specified:
@ -193,7 +193,7 @@ The default encoding for these, however, is:
- US-ASCII, if all characters are US-ASCII.
- The script encoding, otherwise;
see (Script Encoding)[rdoc-ref:encodings.rdoc@Script+Encoding].
see (Script Encoding)[rdoc-ref:@Script+Encoding].
== Filesystem \Encoding

26
doc/format_specifications.rdoc
View File

@ -46,42 +46,42 @@ The links lead to the details and examples.
=== \Integer Type Specifiers
- +b+ or +B+: Format +argument+ as a binary integer.
See {Specifiers b and B}[rdoc-ref:format_specifications.rdoc@Specifiers+b+and+B].
See {Specifiers b and B}[rdoc-ref:@Specifiers+b+and+B].
- +d+, +i+, or +u+ (all are identical):
Format +argument+ as a decimal integer.
See {Specifier d}[rdoc-ref:format_specifications.rdoc@Specifier+d].
See {Specifier d}[rdoc-ref:@Specifier+d].
- +o+: Format +argument+ as an octal integer.
See {Specifier o}[rdoc-ref:format_specifications.rdoc@Specifier+o].
See {Specifier o}[rdoc-ref:@Specifier+o].
- +x+ or +X+: Format +argument+ as a hexadecimal integer.
See {Specifiers x and X}[rdoc-ref:format_specifications.rdoc@Specifiers+x+and+X].
See {Specifiers x and X}[rdoc-ref:@Specifiers+x+and+X].
=== Floating-Point Type Specifiers
- +a+ or +A+: Format +argument+ as hexadecimal floating-point number.
See {Specifiers a and A}[rdoc-ref:format_specifications.rdoc@Specifiers+a+and+A].
See {Specifiers a and A}[rdoc-ref:@Specifiers+a+and+A].
- +e+ or +E+: Format +argument+ in scientific notation.
See {Specifiers e and E}[rdoc-ref:format_specifications.rdoc@Specifiers+e+and+E].
See {Specifiers e and E}[rdoc-ref:@Specifiers+e+and+E].
- +f+: Format +argument+ as a decimal floating-point number.
See {Specifier f}[rdoc-ref:format_specifications.rdoc@Specifier+f].
See {Specifier f}[rdoc-ref:@Specifier+f].
- +g+ or +G+: Format +argument+ in a "general" format.
See {Specifiers g and G}[rdoc-ref:format_specifications.rdoc@Specifiers+g+and+G].
See {Specifiers g and G}[rdoc-ref:@Specifiers+g+and+G].
=== Other Type Specifiers
- +c+: Format +argument+ as a character.
See {Specifier c}[rdoc-ref:format_specifications.rdoc@Specifier+c].
See {Specifier c}[rdoc-ref:@Specifier+c].
- +p+: Format +argument+ as a string via <tt>argument.inspect</tt>.
See {Specifier p}[rdoc-ref:format_specifications.rdoc@Specifier+p].
See {Specifier p}[rdoc-ref:@Specifier+p].
- +s+: Format +argument+ as a string via <tt>argument.to_s</tt>.
See {Specifier s}[rdoc-ref:format_specifications.rdoc@Specifier+s].
See {Specifier s}[rdoc-ref:@Specifier+s].
- <tt>%</tt>: Format +argument+ (<tt>'%'</tt>) as a single percent character.
See {Specifier %}[rdoc-ref:format_specifications.rdoc@Specifier+-25].
See {Specifier %}[rdoc-ref:@Specifier+-25].
== Flags
The effect of a flag may vary greatly among type specifiers.
These remarks are general in nature.
See {type-specific details}[rdoc-ref:format_specifications.rdoc@Type+Specifier+Details+and+Examples].
See {type-specific details}[rdoc-ref:@Type+Specifier+Details+and+Examples].
Multiple flags may be given with single type specifier;
order does not matter.

2
doc/packed_data.rdoc
View File

@ -159,7 +159,7 @@ Any directive may be followed by either of these modifiers:
'AB'.unpack('C3') # => [65, 66, nil]
Note: Directives in <tt>%w[A a Z m]</tt> use +count+ differently;
see {String Directives}[rdoc-ref:packed_data.rdoc@String+Directives].
see {String Directives}[rdoc-ref:@String+Directives].
If elements don't fit the provided directive, only least significant bits are encoded:

70
doc/ruby/options.md
View File

@ -68,15 +68,15 @@ nil
See also:
- {Option -a}[rdoc-ref:ruby/options.md@a-3A+Split+Input+Lines+into+Fields]:
- {Option -a}[rdoc-ref:@a-3A+Split+Input+Lines+into+Fields]:
Split input lines into fields.
- {Option -F}[rdoc-ref:ruby/options.md@F-3A+Set+Input+Field+Separator]:
- {Option -F}[rdoc-ref:@F-3A+Set+Input+Field+Separator]:
Set input field separator.
- {Option -l}[rdoc-ref:ruby/options.md@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
- {Option -l}[rdoc-ref:@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
Set output record separator; chop lines.
- {Option -n}[rdoc-ref:ruby/options.md@n-3A+Run+Program+in+gets+Loop]:
- {Option -n}[rdoc-ref:@n-3A+Run+Program+in+gets+Loop]:
Run program in `gets` loop.
- {Option -p}[rdoc-ref:ruby/options.md@p-3A+-n-2C+with+Printing]:
- {Option -p}[rdoc-ref:@p-3A+-n-2C+with+Printing]:
`-n`, with printing.
### `-a`: Split Input Lines into Fields
@ -98,15 +98,15 @@ and the default field separator is `$;`.
See also:
- {Option -0}[rdoc-ref:ruby/options.md@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
- {Option -0}[rdoc-ref:@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
Set `$/` (input record separator).
- {Option -F}[rdoc-ref:ruby/options.md@F-3A+Set+Input+Field+Separator]:
- {Option -F}[rdoc-ref:@F-3A+Set+Input+Field+Separator]:
Set input field separator.
- {Option -l}[rdoc-ref:ruby/options.md@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
- {Option -l}[rdoc-ref:@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
Set output record separator; chop lines.
- {Option -n}[rdoc-ref:ruby/options.md@n-3A+Run+Program+in+gets+Loop]:
- {Option -n}[rdoc-ref:@n-3A+Run+Program+in+gets+Loop]:
Run program in `gets` loop.
- {Option -p}[rdoc-ref:ruby/options.md@p-3A+-n-2C+with+Printing]:
- {Option -p}[rdoc-ref:@p-3A+-n-2C+with+Printing]:
`-n`, with printing.
### `-c`: Check Syntax
@ -228,15 +228,15 @@ The argument must immediately follow the option
See also:
- {Option -0}[rdoc-ref:ruby/options.md@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
- {Option -0}[rdoc-ref:@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
Set `$/` (input record separator).
- {Option -a}[rdoc-ref:ruby/options.md@a-3A+Split+Input+Lines+into+Fields]:
- {Option -a}[rdoc-ref:@a-3A+Split+Input+Lines+into+Fields]:
Split input lines into fields.
- {Option -l}[rdoc-ref:ruby/options.md@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
- {Option -l}[rdoc-ref:@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
Set output record separator; chop lines.
- {Option -n}[rdoc-ref:ruby/options.md@n-3A+Run+Program+in+gets+Loop]:
- {Option -n}[rdoc-ref:@n-3A+Run+Program+in+gets+Loop]:
Run program in `gets` loop.
- {Option -p}[rdoc-ref:ruby/options.md@p-3A+-n-2C+with+Printing]:
- {Option -p}[rdoc-ref:@p-3A+-n-2C+with+Printing]:
`-n`, with printing.
### `-h`: Print Short Help Message
@ -314,15 +314,15 @@ $ ruby -ln -e 'p $_' desiderata.txt
See also:
- {Option -0}[rdoc-ref:ruby/options.md@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
- {Option -0}[rdoc-ref:@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
Set `$/` (input record separator).
- {Option -a}[rdoc-ref:ruby/options.md@a-3A+Split+Input+Lines+into+Fields]:
- {Option -a}[rdoc-ref:@a-3A+Split+Input+Lines+into+Fields]:
Split input lines into fields.
- {Option -F}[rdoc-ref:ruby/options.md@F-3A+Set+Input+Field+Separator]:
- {Option -F}[rdoc-ref:@F-3A+Set+Input+Field+Separator]:
Set input field separator.
- {Option -n}[rdoc-ref:ruby/options.md@n-3A+Run+Program+in+gets+Loop]:
- {Option -n}[rdoc-ref:@n-3A+Run+Program+in+gets+Loop]:
Run program in `gets` loop.
- {Option -p}[rdoc-ref:ruby/options.md@p-3A+-n-2C+with+Printing]:
- {Option -p}[rdoc-ref:@p-3A+-n-2C+with+Printing]:
`-n`, with printing.
### `-n`: Run Program in `gets` Loop
@ -348,15 +348,15 @@ be on good terms with all persons.
See also:
- {Option -0}[rdoc-ref:ruby/options.md@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
- {Option -0}[rdoc-ref:@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
Set `$/` (input record separator).
- {Option -a}[rdoc-ref:ruby/options.md@a-3A+Split+Input+Lines+into+Fields]:
- {Option -a}[rdoc-ref:@a-3A+Split+Input+Lines+into+Fields]:
Split input lines into fields.
- {Option -F}[rdoc-ref:ruby/options.md@F-3A+Set+Input+Field+Separator]:
- {Option -F}[rdoc-ref:@F-3A+Set+Input+Field+Separator]:
Set input field separator.
- {Option -l}[rdoc-ref:ruby/options.md@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
- {Option -l}[rdoc-ref:@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
Set output record separator; chop lines.
- {Option -p}[rdoc-ref:ruby/options.md@p-3A+-n-2C+with+Printing]:
- {Option -p}[rdoc-ref:@p-3A+-n-2C+with+Printing]:
`-n`, with printing.
### `-p`: `-n`, with Printing
@ -377,15 +377,15 @@ be on good terms with all persons.
See also:
- {Option -0}[rdoc-ref:ruby/options.md@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
- {Option -0}[rdoc-ref:@0-3A+Set+-24-2F+-28Input+Record+Separator-29]:
Set `$/` (input record separator).
- {Option -a}[rdoc-ref:ruby/options.md@a-3A+Split+Input+Lines+into+Fields]:
- {Option -a}[rdoc-ref:@a-3A+Split+Input+Lines+into+Fields]:
Split input lines into fields.
- {Option -F}[rdoc-ref:ruby/options.md@F-3A+Set+Input+Field+Separator]:
- {Option -F}[rdoc-ref:@F-3A+Set+Input+Field+Separator]:
Set input field separator.
- {Option -l}[rdoc-ref:ruby/options.md@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
- {Option -l}[rdoc-ref:@l-3A+Set+Output+Record+Separator-3B+Chop+Lines]:
Set output record separator; chop lines.
- {Option -n}[rdoc-ref:ruby/options.md@n-3A+Run+Program+in+gets+Loop]:
- {Option -n}[rdoc-ref:@n-3A+Run+Program+in+gets+Loop]:
Run program in `gets` loop.
### `-r`: Require Library
@ -434,7 +434,7 @@ $ ruby -s t.rb -foo=baz -bar=bat
```
The option may not be used with
{option -e}[rdoc-ref:ruby/options.md@e-3A+Execute+Given+Ruby+Code]
{option -e}[rdoc-ref:@e-3A+Execute+Given+Ruby+Code]
### `-S`: Search Directories in `ENV['PATH']`
@ -583,7 +583,7 @@ ruby - Copyright (C) 1993-2024 Yukihiro Matsumoto
### `--debug`: Alias for `-d`
Option `--debug` is an alias for
{option -d}[rdoc-ref:ruby/options.md@d-3A+Set+-24DEBUG+to+true].
{option -d}[rdoc-ref:@d-3A+Set+-24DEBUG+to+true].
### `--disable`: Disable Features
@ -617,9 +617,9 @@ option was given:
- `--dump=help`:
Same as {option \-\-help}[options_md.html#label--help-3A+Print+Help+Message].
- `--dump=syntax`:
Same as {option -c}[rdoc-ref:ruby/options.md@c-3A+Check+Syntax].
Same as {option -c}[rdoc-ref:@c-3A+Check+Syntax].
- `--dump=usage`:
Same as {option -h}[rdoc-ref:ruby/options.md@h-3A+Print+Short+Help+Message].
Same as {option -h}[rdoc-ref:@h-3A+Print+Short+Help+Message].
- `--dump=version`:
Same as {option \-\-version}[options_md.html#label--version-3A+Print+Ruby+Version].
@ -641,7 +641,7 @@ see {option --disable}[options_md.html#label--disable-3A+Disable+Features].
### `--encoding`: Alias for `-E`.
Option `--encoding` is an alias for
{option -E}[rdoc-ref:ruby/options.md@E-3A+Set+Default+Encodings].
{option -E}[rdoc-ref:@E-3A+Set+Default+Encodings].
### `--external-encoding`: Set Default External \Encoding

7
doc/strftime_formatting.rdoc
View File

@ -136,7 +136,7 @@ the only required part is the conversion specifier, so we begin with that.
t = Time.now # => 2022-06-29 07:10:20.3230914 -0500
t.strftime('%N') # => "323091400" # Default.
Use {width specifiers}[rdoc-ref:strftime_formatting.rdoc@Width+Specifiers]
Use {width specifiers}[rdoc-ref:@Width+Specifiers]
to adjust units:
t.strftime('%3N') # => "323" # Milliseconds.
@ -522,6 +522,5 @@ An ISO 8601 combined date and time representation may be any
ISO 8601 date and any ISO 8601 time,
separated by the letter +T+.
For the relevant +strftime+ formats, see
{Dates}[rdoc-ref:strftime_formatting.rdoc@Dates]
and {Times}[rdoc-ref:strftime_formatting.rdoc@Times] above.
For the relevant +strftime+ formats, see {Dates}[rdoc-ref:@Dates] and
{Times}[rdoc-ref:@Times] above.

2
doc/syntax/assignment.rdoc
View File

@ -9,7 +9,7 @@ Assignment creates a local variable if the variable was not previously
referenced.
An assignment expression result is always the assigned value, including
{assignment methods}[rdoc-ref:syntax/assignment.rdoc@Assignment+Methods].
{assignment methods}[rdoc-ref:@Assignment+Methods].
== Local Variable Names