Skip to content

Commit cefd4a2

Browse files
nobunobu
committed
[DOC] Use backticks instead of <tt> except for nested markups
1 parent 74b45dc commit cefd4a2

1 file changed

Lines changed: 74 additions & 74 deletions

File tree

‎doc/globals.md‎

Lines changed: 74 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -14,70 +14,70 @@ require 'English'
1414

1515
### Exceptions
1616

17-
| Variable | English | Contains |
18-
|-------------|--------------------------|----------------------------------------------------|
19-
| <tt>$!</tt> | <tt>$ERROR_INFO</tt> | Exception object; set by Kernel#raise. |
20-
| <tt>$@</tt> | <tt>$ERROR_POSITION</tt> | Array of backtrace positions; set by Kernel#raise. |
17+
| Variable | English | Contains |
18+
|-------------|-------------------|----------------------------------------------------|
19+
| `$!` | `$ERROR_INFO` | Exception object; set by Kernel#raise. |
20+
| `$@` | `$ERROR_POSITION` | Array of backtrace positions; set by Kernel#raise. |
2121

2222
### Pattern Matching
2323

24-
| Variable | English | Contains |
25-
|-------------|----------------------------|--------------------------------------------------|
26-
| <tt>$~</tt> | <tt>$LAST_MATCH_INFO</tt> | MatchData object; set by matcher method. |
27-
| <tt>$&</tt> | <tt>$MATCH</tt> | Matched substring; set by matcher method. |
28-
| <tt>$`</tt> | <tt>$PRE_MATCH</tt> | Substring left of match; set by matcher method. |
29-
| <tt>$'</tt> | <tt>$POST_MATCH</tt> | Substring right of match; set by matcher method. |
30-
| <tt>$+</tt> | <tt>$LAST_PAREN_MATCH</tt> | Last group matched; set by matcher method. |
31-
| <tt>$1</tt> | | First group matched; set by matcher method. |
32-
| <tt>$2</tt> | | Second group matched; set by matcher method. |
33-
| <tt>$</tt>n | | nth group matched; set by matcher method. |
24+
| Variable | English | Contains |
25+
|---------------|---------------------|--------------------------------------------------|
26+
| `$~` | `$LAST_MATCH_INFO` | MatchData object; set by matcher method. |
27+
| `$&` | `$MATCH` | Matched substring; set by matcher method. |
28+
| `` $` `` | `$PRE_MATCH` | Substring left of match; set by matcher method. |
29+
| `$'` | `$POST_MATCH` | Substring right of match; set by matcher method. |
30+
| `$+` | `$LAST_PAREN_MATCH` | Last group matched; set by matcher method. |
31+
| `$1` | | First group matched; set by matcher method. |
32+
| `$2` | | Second group matched; set by matcher method. |
33+
| <tt>$_n_</tt> | | <i>n</i>th group matched; set by matcher method. |
3434

3535
### Separators
3636

37-
| Variable | English | Contains |
38-
|----------------------|-----------------------------------|--------------------------------------------------|
39-
| <tt>$/</tt> | <tt>$INPUT_RECORD_SEPARATOR</tt> | Input record separator; initially newline. |
40-
| <tt>$\\\\\\\\</tt> | <tt>$OUTPUT_RECORD_SEPARATOR</tt> | Output record separator; initially <tt>nil</tt>. |
37+
| Variable | English | Contains |
38+
|----------|----------------------------|--------------------------------------------|
39+
| `$/` | `$INPUT_RECORD_SEPARATOR` | Input record separator; initially newline. |
40+
| `$\` | `$OUTPUT_RECORD_SEPARATOR` | Output record separator; initially `nil`. |
4141

4242
### Streams
4343

44-
| Variable | English | Contains |
45-
|------------------|-------------------------------------------|-----------------------------------------------------------|
46-
| <tt>$stdin</tt> | | Standard input stream; initially <tt>STDIN</tt>. |
47-
| <tt>$stdout</tt> | | Standard input stream; initially <tt>STDIOUT</tt>. |
48-
| <tt>$stderr</tt> | | Standard input stream; initially <tt>STDERR</tt>. |
49-
| <tt>$<</tt> | <tt>$DEFAULT_INPUT</tt> | Default standard input; <tt>ARGF</tt> or <tt>$stdin</tt>. |
50-
| <tt>$></tt> | <tt>$DEFAULT_OUTPUT</tt> | Default standard output; initially <tt>$stdout</tt>. |
51-
| <tt>$.</tt> | <tt>$INPUT_LINE_NUMBER</tt>, <tt>$NR</tt> | Input position of most recently read stream. |
52-
| <tt>$_</tt> | <tt>$LAST_READ_LINE</tt> | String from most recently read stream. |
44+
| Variable | English | Contains |
45+
|-----------|-----------------------------|-----------------------------------------------|
46+
| `$stdin` | | Standard input stream; initially `STDIN`. |
47+
| `$stdout` | | Standard input stream; initially `STDIOUT`. |
48+
| `$stderr` | | Standard input stream; initially `STDERR`. |
49+
| `$<` | `$DEFAULT_INPUT` | Default standard input; `ARGF` or `$stdin`. |
50+
| `$>` | `$DEFAULT_OUTPUT` | Default standard output; initially `$stdout`. |
51+
| `$.` | `$INPUT_LINE_NUMBER`, `$NR` | Input position of most recently read stream. |
52+
| `$_` | `$LAST_READ_LINE` | String from most recently read stream. |
5353

5454
### Processes
5555

56-
| Variable | English | Contains |
57-
|------------------------------------------------|-------------------------------------|--------------------------------------------------------|
58-
| <tt>$0</tt> | | Initially, the name of the executing program. |
59-
| <tt>$*</tt> | <tt>$ARGV</tt> | Points to the <tt>ARGV</tt> array. |
60-
| <tt>$$</tt> | <tt>$PROCESS_ID</tt>, <tt>$PID</tt> | Process ID of the current process. |
61-
| <tt>$?</tt> | <tt>$CHILD_STATUS</tt> | Process::Status of most recently exited child process. |
62-
| <tt>$LOAD_PATH</tt>, <tt>$:</tt>, <tt>$-I</tt> | | Array of paths to be searched. |
63-
| <tt>$LOADED_FEATURES</tt>, <tt>$"</tt> | | Array of paths to loaded files. |
56+
| Variable | English | Contains |
57+
|---------------------------|-----------------------|--------------------------------------------------------|
58+
| `$0` | | Initially, the name of the executing program. |
59+
| `$*` | `$ARGV` | Points to the `ARGV` array. |
60+
| `$$` | `$PROCESS_ID`, `$PID` | Process ID of the current process. |
61+
| `$?` | `$CHILD_STATUS` | Process::Status of most recently exited child process. |
62+
| `$LOAD_PATH`, `$:`, `$-I` | | Array of paths to be searched. |
63+
| `$LOADED_FEATURES`, `$"` | | Array of paths to loaded files. |
6464

6565
### Debugging
6666

67-
| Variable | English | Contains |
68-
|--------------------|---------|----------------------------------------------------------------------|
69-
| <tt>$FILENAME</tt> | | The value returned by method ARGF.filename. |
70-
| <tt>$DEBUG</tt> | | Initially, whether option <tt>-d</tt> or <tt>--debug</tt> was given. |
71-
| <tt>$VERBOSE</tt> | | Initially, whether option <tt>-V</tt> or <tt>-W</tt> was given. |
67+
| Variable | English | Contains |
68+
|-------------|---------|--------------------------------------------------------|
69+
| `$FILENAME` | | The value returned by method ARGF.filename. |
70+
| `$DEBUG` | | Initially, whether option `-d` or `--debug` was given. |
71+
| `$VERBOSE` | | Initially, whether option `-V` or `-W` was given. |
7272

7373
### Other Variables
7474

75-
| Variable | English | Contains |
76-
|--------------|---------|-------------------------------------------------------|
77-
| <tt>$-a</tt> | | Whether option <tt>-a</tt> was given. |
78-
| <tt>$-i</tt> | | Extension given with command-line option <tt>-i</tt>. |
79-
| <tt>$-l</tt> | | Whether option <tt>-l</tt> was given. |
80-
| <tt>$-p</tt> | | Whether option <tt>-p</tt> was given. |
75+
| Variable | English | Contains |
76+
|----------|---------|------------------------------------------------|
77+
| `$-a` | | Whether option `-a` was given. |
78+
| `$-i` | | Extension given with command-line option `-i`. |
79+
| `$-l` | | Whether option `-l` was given. |
80+
| `$-p` | | Whether option `-p` was given. |
8181

8282
## Exceptions
8383

@@ -165,7 +165,7 @@ English - `$LAST_PAREN_MATCH`.
165165

166166
### `$1`, `$2`, \Etc. (Matched Group)
167167

168-
For `$_n_` the _nth_ group of the match.
168+
For <tt>$_n_</tt> the <i>n</i>th group of the match.
169169

170170
No \English.
171171

@@ -179,7 +179,7 @@ English - `$INPUT_RECORD_SEPARATOR`, `$RS`.
179179

180180
Aliased as `$-0`.
181181

182-
### `$\\` (Output Record Separator)
182+
### `$\` (Output Record Separator)
183183

184184
An output record separator, initially `nil`.
185185

@@ -270,9 +270,9 @@ by Kernel#load and Kernel#require.
270270
Singleton method `$LOAD_PATH.resolve_feature_path(feature)`
271271
returns:
272272

273-
- `[:rb, _path_]`, where `path` is the path to the Ruby file
274-
to be loaded for the given `feature`.
275-
- `[:so, _path_]`, where `path` is the path to the shared object file
273+
- <tt>[:rb, _path_]</tt>, where `path` is the path to the Ruby file to be
274+
loaded for the given `feature`.
275+
- <tt>[:so, _path_]</tt>, where `path` is the path to the shared object file
276276
to be loaded for the given `feature`.
277277
- `nil` if there is no such `feature` and `path`.
278278

@@ -373,35 +373,35 @@ Whether command-line option `-p` was given; read-only.
373373

374374
### Streams
375375

376-
| Constant | Contains |
377-
|-----------------|-------------------------|
378-
| <tt>STDIN</tt> | Standard input stream. |
379-
| <tt>STDOUT</tt> | Standard output stream. |
380-
| <tt>STDERR</tt> | Standard error stream. |
376+
| Constant | Contains |
377+
|----------|-------------------------|
378+
| `STDIN` | Standard input stream. |
379+
| `STDOUT` | Standard output stream. |
380+
| `STDERR` | Standard error stream. |
381381

382382
### Environment
383383

384-
| Constant | Contains |
385-
|------------------------------|--------------------------------------------------------------------------------------|
386-
| <tt>ENV</tt> | Hash of current environment variable names and values. |
387-
| <tt>ARGF</tt> | String concatenation of files given on the command line, or <tt>$stdin</tt> if none. |
388-
| <tt>ARGV</tt> | Array of the given command-line arguments. |
389-
| <tt>TOPLEVEL_BINDING</tt> | Binding of the top level scope. |
390-
| <tt>RUBY_VERSION</tt> | String Ruby version. |
391-
| <tt>RUBY_RELEASE_DATE</tt> | String Ruby release date. |
392-
| <tt>RUBY_PLATFORM</tt> | String Ruby platform. |
393-
| <tt>RUBY_PATCH_LEVEL</tt> | String Ruby patch level. |
394-
| <tt>RUBY_REVISION</tt> | String Ruby revision. |
395-
| <tt>RUBY_COPYRIGHT</tt> | String Ruby copyright. |
396-
| <tt>RUBY_ENGINE</tt> | String Ruby engine. |
397-
| <tt>RUBY_ENGINE_VERSION</tt> | String Ruby engine version. |
398-
| <tt>RUBY_DESCRIPTION</tt> | String Ruby description. |
384+
| Constant | Contains |
385+
|-----------------------|-------------------------------------------------------------------------------|
386+
| `ENV` | Hash of current environment variable names and values. |
387+
| `ARGF` | String concatenation of files given on the command line, or `$stdin` if none. |
388+
| `ARGV` | Array of the given command-line arguments. |
389+
| `TOPLEVEL_BINDING` | Binding of the top level scope. |
390+
| `RUBY_VERSION` | String Ruby version. |
391+
| `RUBY_RELEASE_DATE` | String Ruby release date. |
392+
| `RUBY_PLATFORM` | String Ruby platform. |
393+
| `RUBY_PATCH_LEVEL` | String Ruby patch level. |
394+
| `RUBY_REVISION` | String Ruby revision. |
395+
| `RUBY_COPYRIGHT` | String Ruby copyright. |
396+
| `RUBY_ENGINE` | String Ruby engine. |
397+
| `RUBY_ENGINE_VERSION` | String Ruby engine version. |
398+
| `RUBY_DESCRIPTION` | String Ruby description. |
399399

400400
### Embedded Data
401401

402-
| Constant | Contains |
403-
|---------------|---------------------------------------------------------------------------|
404-
| <tt>DATA</tt> | File containing embedded data (lines following <tt>__END__</tt>, if any). |
402+
| Constant | Contains |
403+
|----------|--------------------------------------------------------------------|
404+
| `DATA` | File containing embedded data (lines following `__END__`, if any). |
405405

406406
## Streams
407407

0 commit comments

Comments
 (0)