[DOC] Enhancements for globals.md by BurdetteLamar · Pull Request #15545 · ruby/ruby

BurdetteLamar · 2025-12-14T16:51:15Z

Replacement for #15389.

nobu · 2025-12-17T08:50:20Z

Don't the tables in the "In Brief" section overlap with those in the "Summary" section?

BurdetteLamar · 2025-12-17T17:52:17Z

Don't the tables in the "In Brief" section overlap with those in the "Summary" section?

Yes, and there are other (major) repetitions. Marking as draft while I study and fix.

nobu · 2025-12-18T00:08:16Z

+
+|   Variable   | \English |                   Initially                   | Read-Only | Set By  |
+|:------------:|:--------:|:---------------------------------------------:|:---------:|---------|
+| `$FILENAME`  |          | The value returned by method `ARGF#filename`. |   Yes.    | `ARGF`  |


nobu · 2025-12-18T00:09:33Z

+Initially `true` if command-line option `-d` or `--debug` is given,
+otherwise initially `false`;


Duplicate with the next sentence.

nobu · 2025-12-18T00:09:48Z

+Initially `true` if command-line option `-v` or `-w` is given,
+otherwise initially `false`;


Duplicate with the next sentence.

nobu · 2025-12-18T00:10:52Z

+Whether command-line option `-l` was set; read-only.
+
+### `$-p`
+
+Whether command-line option `-p` was given; read-only.


nobu · 2025-12-18T00:12:03Z

+### `$-a`
+
+Whether command-line option `-a` was given; read-only.
+
+### `$-i`
+
+Contains the extension given with command-line option `-i`,


Duplicate with the paragraphs after $-F.

nobu · 2025-12-18T00:12:43Z

+### `$;`
+


This is an alias of $-F, not fully-deprecated.

nobu · 2025-12-18T00:13:01Z

 ### Streams

 | Constant | Contains                |
+|----------|-------------------------|


Unnecessary line.

nobu · 2025-12-18T00:14:36Z

+| Constant              | Contains                                                                      |
+|-----------------------|-------------------------------------------------------------------------------|
+| `ENV`                 | Hash of current environment variable names and values.                        |
+| `ARGF`                | String concatenation of files given on the command line, or `$stdin` if none. |
+| `ARGV`                | Array of the given command-line arguments.                                    |
+| `TOPLEVEL_BINDING`    | Binding of the top level scope.                                               |
+| `RUBY_VERSION`        | String Ruby version.                                                          |
+| `RUBY_RELEASE_DATE`   | String Ruby release date.                                                     |
+| `RUBY_PLATFORM`       | String Ruby platform.                                                         |
+| `RUBY_PATCH_LEVEL`    | String Ruby patch level.                                                      |
+| `RUBY_REVISION`       | String Ruby revision.                                                         |
+| `RUBY_COPYRIGHT`      | String Ruby copyright.                                                        |
+| `RUBY_ENGINE`         | String Ruby engine.                                                           |
+| `RUBY_ENGINE_VERSION` | String Ruby engine version.                                                   |
+| `RUBY_DESCRIPTION`    | String Ruby description.                                                      |


nobu · 2025-12-18T00:15:11Z

+|      Constant         | Contains                                                                      |
 |:---------------------:|-------------------------------------------------------------------------------|
+|        `DATA`         | File containing embedded data (lines following `__END__`, if any).            |
 |         `ENV`         | Hash of current environment variable names and values.                        |
 |        `ARGF`         | String concatenation of files given on the command line, or `$stdin` if none. |
 |        `ARGV`         | Array of the given command-line arguments.                                    |


ENV, ARGF, etc are not "Embedded Data".

BurdetteLamar · 2025-12-18T21:57:26Z

Don't the tables in the "In Brief" section overlap with those in the "Summary" section?

Yes, and there are other (major) repetitions. Marking as draft while I study and fix.

I had revised and extended the tables in Summary for use in In Brief, then forgot to remove the entire Summary section. Have now removed, after rolling some of its information to In Brief.

BurdetteLamar · 2025-12-18T21:58:54Z

Thanks, @nobu, for working closely with me on this; I've made some careless errors (now fixed, I hope). I think this revision will make a difference to our readers.

nobu · 2025-12-19T10:28:00Z

+### `$-a`
+
+Whether command-line option `-a` was given; read-only.
+


This is duplicate, $-a is written after $-F.

nobu · 2025-12-19T10:28:32Z

 ### `$-l`

-Whether [command-line option `-l`] was set; read-only.
+Whether command-line option `-l` was set; read-only.


Why removing the link here?

nobu · 2025-12-19T10:31:26Z

-|     `$1`      |                     | First group matched; set by matcher method.      |
-|     `$2`      |                     | Second group matched; set by matcher method.     |
-| <tt>$_n_</tt> |                     | <i>n</i>th group matched; set by matcher method. |
+|    Variable     |      \English       | Contains                          | Initially | Read-Only | Reset By        |


From here to "Debugging", why are the "Variable" columns expanded?
There are enough width already, I guess.

Fixed? (Not sure what's wanted.)

nobu · 2025-12-20T05:32:45Z

-|   `$.`    | `$INPUT_LINE_NUMBER`, `$NR` | Input position of most recently read stream.  |
-|   `$_`    |      `$LAST_READ_LINE`      | String from most recently read stream.        |
+|  Variable |                    \English | Contains                                    | Initially | Read-Only | Reset By             |
+|:---------:|----------------------------:|:-------------------------------------------:|:---------:|:---------:|----------------------|


Why does only this table right-align the "English" column?

Oops! Now fixed.

[DOC] Enhancements for globals.md

6c03378

BurdetteLamar requested a review from nobu December 14, 2025 16:51

BurdetteLamar added the Documentation Improvements to documentation. label Dec 14, 2025

BurdetteLamar marked this pull request as draft December 17, 2025 17:52

nobu requested changes Dec 18, 2025

View reviewed changes

BurdetteLamar added 2 commits December 18, 2025 13:25

[DOC] Repair summary tables

4d011c5

[DOC] Respond to review

1fc031f

BurdetteLamar requested a review from nobu December 18, 2025 13:45

BurdetteLamar marked this pull request as ready for review December 18, 2025 13:45

nobu reviewed Dec 19, 2025

View reviewed changes

BurdetteLamar added 2 commits December 19, 2025 11:10

[DOC] Respond to review

50fea9e

[DOC] Respond to review

79d4a8b

BurdetteLamar requested a review from nobu December 19, 2025 11:15

nobu reviewed Dec 20, 2025

View reviewed changes

nobu approved these changes Dec 20, 2025

View reviewed changes

[DOC] Fix table alignment

dbeb38c

BurdetteLamar requested a review from nobu December 20, 2025 12:54

BurdetteLamar merged commit 5cdda61 into ruby:master Dec 20, 2025
29 checks passed

	\| `$FILENAME` \| \| The value returned by method `ARGF#filename`. \| Yes. \| `ARGF` \|
	\| `$FILENAME` \| \| The value returned by method `ARGF.filename`. \| Yes. \| `ARGF` \|

		Initially `true` if command-line option `-d` or `--debug` is given,
		otherwise initially `false`;

		### `$-a`

		Whether command-line option `-a` was given; read-only.

Conversation

BurdetteLamar commented Dec 14, 2025

Uh oh!

nobu commented Dec 17, 2025

Uh oh!

BurdetteLamar commented Dec 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BurdetteLamar commented Dec 18, 2025

Uh oh!

BurdetteLamar commented Dec 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants