NotificationsYou must be signed in to change notification settings
Fork5.5k
Star23.2k

[DOC] Enhancements for globals.md#15545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

BurdetteLamar wants to merge5 commits intoruby:master

base:master

Choose a base branch

fromBurdetteLamar:globals_doc

Open

[DOC] Enhancements for globals.md#15545

BurdetteLamar wants to merge5 commits intoruby:masterfromBurdetteLamar:globals_doc

+72 −67

Conversation

Copy link

Member

BurdetteLamar commentedDec 14, 2025

Replacement for#15389.

[DOC] Enhancements for globals.md

6c03378

BurdetteLamar requested a review fromnobu

December 14, 2025 16:51

BurdetteLamar added the DocumentationImprovements to documentation. label

Dec 14, 2025

Copy link

Member

nobu commentedDec 17, 2025

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

Copy link

MemberAuthor

BurdetteLamar commentedDec 17, 2025

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.

BurdetteLamar marked this pull request as draft

December 17, 2025 17:52

nobu requested changes

Dec 18, 2025

View reviewed changes

doc/language/globals.md Outdated


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

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

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

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 401 to 402

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

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Duplicate with the next sentence.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 413 to 414

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

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Duplicate with the next sentence.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 457 to 461

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

		###`$-p`

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

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Duplicate.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 427 to 433

		###`$-a`

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

		###`$-i`

		Contains the extension given with command-line option`-i`,

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Duplicate with the paragraphs after$-F.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 480 to 481

		###`$;`

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

		###Streams

		\| Constant\| Contains\|
		\|----------\|-------------------------\|

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Unnecessary line.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md

Comment on lines 497 to 511

		\| 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.\|

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Duplicate.

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

doc/language/globals.md Outdated

Comment on lines 515 to 520

		\| 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.\|

Copy link

Member

nobuDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

MemberAuthor

BurdetteLamarDec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed.

BurdetteLamar added2 commits

December 18, 2025 13:25

[DOC] Repair summary tables

4d011c5

[DOC] Respond to review

1fc031f

BurdetteLamar requested a review fromnobu

December 18, 2025 13:45

BurdetteLamar marked this pull request as ready for review

December 18, 2025 13:45

Copy link

MemberAuthor

BurdetteLamar commentedDec 18, 2025

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.

Copy link

MemberAuthor

BurdetteLamar commentedDec 18, 2025

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 reviewed

Dec 19, 2025

View reviewed changes

doc/language/globals.md

Comment on lines +355 to +358

		###`$-a`

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

Copy link

Member

nobuDec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

doc/language/globals.md Outdated

		###`$-l`

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

Copy link

Member

nobuDec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Why removing the link here?

Copy link

MemberAuthor

BurdetteLamarDec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Restored.

doc/language/globals.md Outdated

		\|`$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\|

Copy link

Member

nobuDec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

MemberAuthor

BurdetteLamarDec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Fixed? (Not sure what's wanted.)

BurdetteLamar added2 commits

December 19, 2025 11:10

[DOC] Respond to review

50fea9e

[DOC] Respond to review

79d4a8b

BurdetteLamar requested a review fromnobu

December 19, 2025 11:15

Labels

Documentation

Improvements to documentation.

		\| 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.\|

		\| 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.\|

		\|`$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\|

Movatterモバイル変換

[DOC] Enhancements for globals.md#15545

Are you sure you want to change the base?

[DOC] Enhancements for globals.md#15545

Conversation

BurdetteLamar commentedDec 14, 2025

Uh oh!

nobu commentedDec 17, 2025

Uh oh!

BurdetteLamar commentedDec 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 commentedDec 18, 2025

Uh oh!

BurdetteLamar commentedDec 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants