From b8a7a610f45b0b168e8abc4fb3b530dd76fb636e Mon Sep 17 00:00:00 2001 From: Soutaro Matsumoto Date: Wed, 18 Dec 2024 22:55:14 +0900 Subject: [PATCH 1/2] bundle update rdoc --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 80a194db2..c005fac45 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -85,7 +85,7 @@ GEM rb-fsevent (0.11.2) rb-inotify (0.11.1) ffi (~> 1.0) - rdoc (6.9.1) + rdoc (6.10.0) psych (>= 4.0.0) regexp_parser (2.9.3) rspec (3.13.0) From e28341092fbcde643268c649a2d89e629e04d6e7 Mon Sep 17 00:00:00 2001 From: Soutaro Matsumoto Date: Wed, 18 Dec 2024 23:07:18 +0900 Subject: [PATCH 2/2] Generate docs with the updated RDoc --- core/constants.rbs | 63 ++++++++++++++++++++++++++++++++++++++++++++++ core/env.rbs | 5 ++++ 2 files changed, 68 insertions(+) diff --git a/core/constants.rbs b/core/constants.rbs index 18b70ea32..a1a5b8491 100644 --- a/core/constants.rbs +++ b/core/constants.rbs @@ -1,33 +1,96 @@ +# +# ARGF is a stream designed for use in scripts that process files given as +# command-line arguments or passed in via STDIN. +# +# See ARGF (the class) for more details. +# ARGF: RBS::Unnamed::ARGFClass +# +# ARGV contains the command line arguments used to run ruby. +# +# A library like OptionParser can be used to process command-line arguments. +# ARGV: Array[String] CROSS_COMPILING: true? +# +# DATA is a File that contains the data section of the executed file. To create +# a data section use `__END__`: +# +# $ cat t.rb +# puts DATA.gets +# __END__ +# hello world! +# +# $ ruby t.rb +# hello world! +# DATA: File +# +# The copyright string for ruby +# RUBY_COPYRIGHT: String +# +# The full ruby version string, like `ruby -v` prints +# RUBY_DESCRIPTION: String +# +# The engine or interpreter this ruby uses. +# RUBY_ENGINE: String +# +# The version of the engine or interpreter this ruby uses. +# RUBY_ENGINE_VERSION: String +# +# The patchlevel for this ruby. If this is a development build of ruby the +# patchlevel will be -1 +# RUBY_PATCHLEVEL: Integer +# +# The platform for this ruby +# RUBY_PLATFORM: String +# +# The date this ruby was released +# RUBY_RELEASE_DATE: String +# +# The GIT commit hash for this ruby. +# RUBY_REVISION: String +# +# The running version of ruby +# RUBY_VERSION: String +# +# Holds the original stderr +# STDERR: IO +# +# Holds the original stdin +# STDIN: IO +# +# Holds the original stdout +# STDOUT: IO +# +# The Binding of the top level scope +# TOPLEVEL_BINDING: Binding diff --git a/core/env.rbs b/core/env.rbs index 14bb4fab3..438fdaed6 100644 --- a/core/env.rbs +++ b/core/env.rbs @@ -1 +1,6 @@ +# +# ENV is a Hash-like accessor for environment variables. +# +# See ENV (the class) for more details. +# ENV: RBS::Unnamed::ENVClass