rbs 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5774c0ae32533d1da69481ae4b413817580fd9974b445a67bef1faf4ff48080
-  data.tar.gz: 3f4552b3a91d2fc233f110b8682b73674454163a540d271c9f355daf6e61b5d3
+  metadata.gz: 26f1a45c1e5dbf02bc102b1fc68c925979facec75a9971e9b405481087fc9ad9
+  data.tar.gz: b6e8bee27043e2bc710a894fe9518266dac265a8d0afc685193ca157dc5e8cac
 SHA512:
-  metadata.gz: '0827ff2d63c104b99b07b5319f581b559b6dd7b6e9a26ae2f65d2fc5f8b9c435fff19690b9efe1dfed4c5d220c61c4afdb74203a2275b27bd95a934fbe467c16'
-  data.tar.gz: 7584c2471066032562ca5c3eb39dc8880e764f0fa880fcb9d1ee5e5b56b29fad9d2991b570b17ccf8b9e1f9ecf395c4719609d176dc2058fce6bfac03455d79f
+  metadata.gz: 918413c661460215dc7de7404e6b9a6f117a56493e91b2c1f059524352c9fe84c6deff43c43987816eaca958224eb57c3206f463dd3fe09b7e402f2a5daed92d
+  data.tar.gz: b743905981aa9b998c41b84a6dc9ae81b5d2456a89218c2840a490260552dc1919a7c2cc46d4293b49df120ccada9b220ffd06b25ebfe47f941a0632b4cc63fc

data/.github/workflows/comments.yml

@@ -12,23 +12,23 @@ jobs:
     container:
       image: rubylang/ruby:3.1-focal
     steps:
-    - uses: actions/checkout@v3
-    - name: Install dependencies
-      run: |
-        apt-get update
-        apt-get install -y libdb-dev curl
-    - name: Update rubygems & bundler
-      run: |
-        ruby -v
-        gem update --system
-    - name: bundle config set with
-      run: |
-        echo "NO_MINITEST=true" >> $GITHUB_ENV
-        bundle config set --local without 'minitest'
-      if: "contains(matrix.container_tag, 'master-nightly')"
-    - name: bin/setup
-      run: |
-        bin/setup
-    - name: Check if `rake annotate` has been executed
-      run: |
-        bundle exec rake annotate confirm_annotation
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y libdb-dev curl
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - name: bundle config set with
+        run: |
+          echo "NO_MINITEST=true" >> $GITHUB_ENV
+          bundle config set --local without 'minitest'
+        if: "contains(matrix.container_tag, 'master-nightly')"
+      - name: bin/setup
+        run: |
+          bin/setup
+      - name: Check if `rake annotate` has been executed
+        run: |
+          bundle exec rake annotate confirm_annotation

data/.github/workflows/ruby.yml

@@ -12,70 +12,70 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - master-nightly-focal
-        - 3.1-focal
-        - 3.0-focal
-        - 2.7-bionic
-        - 2.6-bionic
+          - master-nightly-focal
+          - 3.1-focal
+          - 3.0-focal
+          - 2.7-bionic
+          - 2.6-bionic
         job:
-        - test
-        - stdlib_test
-        - rubocop validate test_doc build test_generate_stdlib
-        - lexer confirm_lexer
-        - lexer compile
+          - test
+          - stdlib_test
+          - rubocop validate test_doc build test_generate_stdlib
+          - lexer confirm_lexer
+          - lexer compile
         exclude:
-        - container_tag: master-nightly-focal
-          job: confirm_lexer
-        - container_tag: 2.6-bionic
-          job: stdlib_test
-        - container_tag: 2.7-bionic
-          job: stdlib_test
-        - container_tag: 3.0-focal
-          job: stdlib_test
+          - container_tag: master-nightly-focal
+            job: confirm_lexer
+          - container_tag: 2.6-bionic
+            job: stdlib_test
+          - container_tag: 2.7-bionic
+            job: stdlib_test
+          - container_tag: 3.0-focal
+            job: stdlib_test
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
-    - uses: actions/checkout@v3
-    - name: Set working directory as safe
-      run: /usr/bin/git config --global --add safe.directory $(pwd)
-    - name: Install dependencies
-      run: |
-        apt-get update
-        apt-get install -y libdb-dev curl autoconf automake m4 libtool
-    - name: Install Re2c
-      if: contains(matrix.job, 'lexer')
-      run: |
-        cd /tmp
-        curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.0.tar.gz > re2c-3.0.tar.gz
-        tar xf re2c-3.0.tar.gz
-        cd re2c-3.0
-        autoreconf -i -W all
-        ./configure
-        make
-        make install
-    - name: Update rubygems & bundler
-      run: |
-        ruby -v
-        gem update --system
-    - name: bundle config set with
-      run: |
-        echo "NO_MINITEST=true" >> $GITHUB_ENV
-        bundle config set --local without 'minitest'
-      if: "contains(matrix.container_tag, 'master-nightly')"
-    - name: bin/setup
-      run: |
-        bin/setup
-    - name: Run test
-      run: |
-        bundle exec rake ${{ matrix.job }}
+      - uses: actions/checkout@v3
+      - name: Set working directory as safe
+        run: /usr/bin/git config --global --add safe.directory $(pwd)
+      - name: Install dependencies
+        run: |
+          apt-get update
+          apt-get install -y libdb-dev curl autoconf automake m4 libtool
+      - name: Install Re2c
+        if: contains(matrix.job, 'lexer')
+        run: |
+          cd /tmp
+          curl -L https://github.com/skvadrik/re2c/archive/refs/tags/3.0.tar.gz > re2c-3.0.tar.gz
+          tar xf re2c-3.0.tar.gz
+          cd re2c-3.0
+          autoreconf -i -W all
+          ./configure
+          make
+          make install
+      - name: Update rubygems & bundler
+        run: |
+          ruby -v
+          gem update --system
+      - name: bundle config set with
+        run: |
+          echo "NO_MINITEST=true" >> $GITHUB_ENV
+          bundle config set --local without 'minitest'
+        if: "contains(matrix.container_tag, 'master-nightly')"
+      - name: bin/setup
+        run: |
+          bin/setup
+      - name: Run test
+        run: |
+          bundle exec rake ${{ matrix.job }}
 
   windows:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ windows-2019, windows-2022 ]
-        ruby: [ ucrt, mswin ]
+        os: [windows-2019, windows-2022]
+        ruby: [ucrt, mswin]
     steps:
       - uses: actions/checkout@v3
       - name: load ruby

data/CHANGELOG.md

@@ -2,6 +2,50 @@
 
 ## master
 
+## 2.8.0 (2022-11-24)
+
+### Signature updates
+
+* random ([#1144](https://github.com/ruby/rbs/pull/1144))
+
+### Library changes
+
+* Fix SEGV when give invalid object to `variables:` ([#1153](https://github.com/ruby/rbs/pull/1153))
+
+### Miscellaneous
+
+* Fix some typos ([#1155](https://github.com/ruby/rbs/pull/1155))
+* Fix a formatting some YAML files ([#1154](https://github.com/ruby/rbs/pull/1154))
+
+## 2.8.0.pre.1 (2022-11-17)
+
+### Signature updates
+
+* `IO` ([#1132](https://github.com/ruby/rbs/pull/1132))
+* `IO::Buffer` ([#1137](https://github.com/ruby/rbs/pull/1137))
+* `IPAddr` ([#1131](https://github.com/ruby/rbs/pull/1131), [#1151](https://github.com/ruby/rbs/pull/1151))
+* `Socket` ([#1133](https://github.com/ruby/rbs/pull/1133), [#1134](https://github.com/ruby/rbs/pull/1134), [#1151](https://github.com/ruby/rbs/pull/1151))
+* `Yaml` ([#1141](https://github.com/ruby/rbs/pull/1141))
+
+### Library changes
+
+* Make type/method-type parser more flexible about input position ([#1140](https://github.com/ruby/rbs/pull/1140))
+* Raise an error if a class definition inherits a module ([#1152](https://github.com/ruby/rbs/pull/1152))
+* Fix SEGV when parse with invalid content ([#1146](https://github.com/ruby/rbs/pull/1146))
+
+#### rbs collection
+
+* Support to call collection command in child dir ([#1025](https://github.com/ruby/rbs/pull/1025), [#1135](https://github.com/ruby/rbs/pull/1135))
+
+### Miscellaneous
+
+* Remove `rubygems` from `rbs`’s manifest ([#1150](https://github.com/ruby/rbs/pull/1150))
+* Use `untyped` instead of `any` in `syntax.md` ([#1147](https://github.com/ruby/rbs/pull/1147))
+* Fix typo and grammatical mistakes in "Generics" section of `syntax.md` ([#1127](https://github.com/ruby/rbs/pull/1127))
+* Add a doc that describes tools related to RBS ([#1125](https://github.com/ruby/rbs/pull/1125))
+* Add self-type-bindings to `syntax.md` ([#1123](https://github.com/ruby/rbs/pull/1123))
+* Add documentation for `...` in `syntax.md` ([#1120](https://github.com/ruby/rbs/pull/1120))
+
 ## 2.7.0 (2022-10-07)
 
 ### Signature updates

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs (2.7.0)
+    rbs (2.8.0)
 
 PATH
   remote: test/assets/test-gem
@@ -47,32 +47,32 @@ GEM
       rake
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     rubocop-rubycw (0.1.6)
       rubocop (~> 1.0)
@@ -80,13 +80,13 @@ GEM
       rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
     singleton (0.1.1)
-    stackprof (0.2.21)
+    stackprof (0.2.22)
     stringio (3.0.2)
     strong_json (2.1.2)
     tempfile (0.1.2)
     test-unit (3.5.5)
       power_assert
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby

data/Steepfile

@@ -9,14 +9,12 @@ target :lib do
     "lib/rbs/test.rb"
   )
 
-  library "set", "pathname", "json", "logger", "monitor", "tsort", "uri", 'yaml', 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest'
+  library "set", "pathname", "json", "logger", "monitor", "tsort", "uri", 'dbm', 'pstore', 'singleton', 'shellwords', 'fileutils', 'find', 'digest'
+  signature 'stdlib/yaml/0'
   signature "stdlib/strscan/0/"
   signature "stdlib/optparse/0/"
   signature "stdlib/rdoc/0/"
 
-  # Please remove the following line after releasing #1107
-  signature "core/rubygems/"
-
   configure_code_diagnostics do |config|
     config[D::Ruby::MethodDefinitionMissing] = :hint
     config[D::Ruby::ElseOnExhaustiveCase] = :hint

data/core/io/buffer.rbs

@@ -706,5 +706,20 @@ class IO
     PRIVATE: Integer
 
     READONLY: Integer
+
+    class LockedError < RuntimeError
+    end
+
+    class AllocationError < RuntimeError
+    end
+
+    class AccessError < RuntimeError
+    end
+
+    class InvalidatedError < RuntimeError
+    end
+
+    class MaskError < ArgumentError
+    end
   end
 end

data/core/io.rbs

@@ -2984,6 +2984,12 @@ IO::TRUNC: Integer
 
 IO::WRONLY: Integer
 
+IO::READABLE: Integer
+
+IO::WRITABLE: Integer
+
+IO::PRIORITY: Integer
+
 # <!-- rdoc-file=io.c -->
 # exception to wait for reading by EAGAIN. see IO.select.
 #

data/core/random.rbs

@@ -21,6 +21,26 @@
 # use SecureRandom for security purpose, instead of this PRNG.
 #
 class Random < RBS::Unnamed::Random_Base
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.new(seed = Random.new_seed) -> prng
+  # -->
+  # Creates a new PRNG using `seed` to set the initial state. If `seed` is
+  # omitted, the generator is initialized with Random.new_seed.
+  #
+  # See Random.srand for more information on the use of seed values.
+  #
+  def initialize: (?Integer seed) -> void
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.bytes(size) -> string
+  # -->
+  # Returns a random binary string. The argument `size` specifies the length of
+  # the returned string.
+  #
+  def self.bytes: (Integer size) -> String
+
   # <!--
   #   rdoc-file=random.c
   #   - prng1 == prng2 -> true or false
@@ -71,6 +91,7 @@ class Random < RBS::Unnamed::Random_Base
   def self.rand: () -> Float
                | (Integer | ::Range[Integer] max) -> Integer
                | (Float | ::Range[Float] max) -> Float
+               | [T < Numeric] (::Range[T]) -> T
 
   # <!--
   #   rdoc-file=random.c
@@ -95,6 +116,52 @@ class Random < RBS::Unnamed::Random_Base
   #     [ rand, rand ]           # => [0.1915194503788923, 0.6221087710398319]
   #
   def self.srand: (?Integer number) -> Integer
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - Random.urandom(size) -> string
+  # -->
+  # Returns a string, using platform providing features. Returned value is
+  # expected to be a cryptographically secure pseudo-random number in binary form.
+  # This method raises a RuntimeError if the feature provided by platform failed
+  # to prepare the result.
+  #
+  # In 2017, Linux manpage random(7) writes that "no cryptographic primitive
+  # available today can hope to promise more than 256 bits of security".  So it
+  # might be questionable to pass size > 32 to this method.
+  #
+  #     Random.urandom(8)  #=> "\x78\x41\xBA\xAF\x7D\xEA\xD8\xEA"
+  #
+  def self.urandom: (Integer) -> String
+
+  # <!--
+  #   rdoc-file=random.c
+  #   - prng.seed -> integer
+  # -->
+  # Returns the seed value used to initialize the generator. This may be used to
+  # initialize another generator with the same state at a later time, causing it
+  # to produce the same sequence of numbers.
+  #
+  #     prng1 = Random.new(1234)
+  #     prng1.seed       #=> 1234
+  #     prng1.rand(100)  #=> 47
+  #
+  #     prng2 = Random.new(prng1.seed)
+  #     prng2.rand(100)  #=> 47
+  #
+  def seed: () -> Integer
+
+  private
+
+  def initialize_copy: (self object) -> self
+
+  def left: () -> untyped
+
+  def marshal_dump: () -> untyped
+
+  def marshal_load: (untyped) -> untyped
+
+  def state: () -> untyped
 end
 
 Random::DEFAULT: Random

data/docs/rbs_by_example.md

@@ -176,7 +176,7 @@ the type variable `Elem`, and the `?` suffix nilable marker.
 When called with an `Integer` positional argument, the return value will be an
 `Array` of whatever type is contained.
 
-The `?` syntax is a convenient shorthand for a union with nil. An equivalent union type woould be `(Elem | nil)`.
+The `?` syntax is a convenient shorthand for a union with nil. An equivalent union type would be `(Elem | nil)`.
 
 ### Keyword Arguments
 

data/docs/syntax.md

@@ -3,18 +3,17 @@
 ## Types
 
 ```markdown
-_type_ ::= _class-name_ _type-arguments_                (Class instance type)
-         | _interface-name_ _type-arguments_            (Interface type)
-         | _alias-name_ _type-arguments_                (Alias type)
-         | `singleton(` _class-name_ `)`                (Class singleton type)
-         | _literal_                                    (Literal type)
-         | _type_ `|` _type_                            (Union type)
-         | _type_ `&` _type_                            (Intersection type)
-         | _type_ `?`                                   (Optional type)
-         | `{` _record-name_ `:` _type_ `,` etc. `}`    (Record type)
-         | `[]` | `[` _type_ `,` etc. `]`               (Tuples)
-         | _type-variable_                              (Type variables)
-         | `^(` _parameters_ `) ->` _type_              (Proc type)
+_type_ ::= _class-name_ _type-arguments_                 (Class instance type)
+         | _interface-name_ _type-arguments_             (Interface type)
+         | _alias-name_ _type-arguments_                 (Alias type)
+         | `singleton(` _class-name_ `)`                 (Class singleton type)
+         | _literal_                                     (Literal type)
+         | _type_ `|` _type_                             (Union type)
+         | _type_ `&` _type_                             (Intersection type)
+         | _type_ `?`                                    (Optional type)
+         | `{` _record-name_ `:` _type_ `,` etc. `}`     (Record type)
+         | `[]` | `[` _type_ `,` etc. `]`                (Tuples)
+         | _type-variable_                               (Type variables)
          | `self`
          | `instance`
          | `class`
@@ -24,6 +23,7 @@ _type_ ::= _class-name_ _type-arguments_                (Class instance type)
          | `top`
          | `bot`
          | `void`
+         | _proc_                                        (Proc type)
 
 _class-name_ ::= _namespace_ /[A-Z]\w*/
 _interface-name_ ::= _namespace_ /_[A-Z]\w*/
@@ -43,6 +43,8 @@ _literal_ ::= _string-literal_
             | _integer-literal_
             | `true`
             | `false`
+
+_proc_ ::= _parameters?_ _self-type-binding?_ _block?_ `->` _type_
 ```
 
 ### Class instance type
@@ -164,15 +166,6 @@ class Ref[T]              # Object is scoped in the class declaration.
 end
 ```
 
-### Proc type
-
-Proc type denotes type of procedures, `Proc` instances.
-
-```
-^(Integer) -> String                  # A procedure with an `Integer` parameter and returns `String`
-^(?String, size: Integer) -> bool     # A procedure with `String` optional parameter, `size` keyword of `Integer`, and returns `bool`
-```
-
 ### Base types
 
 `self` denotes the type of receiver. The type is used to model the open recursion via `self`.
@@ -221,14 +214,28 @@ They are all equivalent for the type system; they are all _top type_.
 
 `void` tells developers a hint that _the value should not be used_. `boolish` implies the value is used as a truth value. `top` is anything else.
 
-## Method Types
+### Proc type
+
+Proc type denotes type of procedures, `Proc` instances.
+
+```
+^(Integer) -> String                  # A procedure with an `Integer` parameter and returns `String`
+^(?String, size: Integer) -> bool     # A procedure with `String` optional parameter, `size` keyword of `Integer`, and returns `bool`
+```
+
+See the next section for details.
+
+## Method Types and Proc Types
 
 ```markdown
-_method-type_ ::= `(` _parameters_ `) ->` _type_                                       # Method without block
-                | `(` _parameters_ `) { (` _parameters_ `) -> ` _type_ `} ->` _type_   # Method with required block
-                | `(` _parameters_ `) ?{ (` _parameters_ `) -> ` _type_ `} ->` _type_  # Method with optional block
+_method-type_ ::= _parameters?_ _block?_ `->` _type_                # Method type
+
+_proc_ ::= `^` _parameters?_ _self-type-binding?_ _block?_ `->` _type_  # Proc type
 
-_parameters_ ::= _required-positionals_ _optional-positionals_ _rest-positional_ _trailing-positionals_ _keywords_
+_parameters?_ ::=                   (Empty)
+                | _parameters_      (Parameters)
+
+_parameters_ ::= `(` _required-positionals_ _optional-positionals_ _rest-positional_ _trailing-positionals_ _keywords_ `)`
 
 _parameter_ ::= _type_ _var-name_                                  # Parameter with var name
               | _type_                                             # Parameter without var name
@@ -243,6 +250,13 @@ _keywords_ ::=                                                     # Empty
              | `?` _keyword_ `:` _parameter_ `,` _keywords_        # Optional keyword
 
 _var-name_ ::= /[a-z]\w*/
+
+_self-type-binding?_ =                              (Empty)
+                     | `[` `self` `:` _type_ `]`    (Self type binding)
+
+_block?_ =                                                           (No block)
+         | `{` _parameters_ _self-type-binding?_ `->` _type_ `}`      (Block)
+         | `?` `{` _parameters_ _self-type-binding?_ `->` _type_ `}`  (Optional block)
 ```
 
 ### Parameters
@@ -250,7 +264,7 @@ _var-name_ ::= /[a-z]\w*/
 A parameter can be a type or a pair of type and variable name.
 Variable name can be used for documentation.
 
-### Examples
+#### Examples
 
 ```
 # Two required positional `Integer` parameters, and returns `String`
@@ -269,6 +283,29 @@ Variable name can be used for documentation.
 (size: Integer sz, ?name: String, ?created_at: Time?) -> void
 ```
 
+### Self type binding
+
+Self type binding represents the type of methods that uses `#instance_eval`, which replaces the value of `self` inside blocks.
+
+```ruby
+123.instance_eval do
+  self + 1        # self is `123` here
+end
+```
+
+Proc types and blocks can have self type bindings.
+
+```rbs
+^(Integer) [self: String] -> void                                     # Proc type with self type binding
+^(Integer) [self: String] { (Symbol) [self: bool] -> void } -> void   # Proc type with self type binding of `String` and a block with self type binding of `bool`
+```
+
+Method type can have blocks with self type bindings.
+
+```rbs
+() { (Integer) [self: String] -> void } -> void     # A method type with block with self type binding
+```
+
 ## Members
 
 ```markdown
@@ -349,6 +386,14 @@ def +: (Float) -> Float
      | (Numeric) -> Numeric
 ```
 
+Overloaded method can have `...` to overload an existing method. It is useful for monkey-patching.
+
+```
+def +: (Float) -> Float
+def +: (BigDecimal) -> BigDecimal
+     | ...
+```
+
 You need extra parentheses on return type to avoid ambiguity.
 
 ```
@@ -516,7 +561,7 @@ Interface declaration can have parameters but allows only a few of the members.
 ```
 interface _Hashing
   def hash: () -> Integer
-  def eql?: (any) -> bool
+  def eql?: (untyped) -> bool
 end
 ```
 
@@ -574,8 +619,8 @@ _generics-bound_ ::=                       (No type bound)
                    | `<` _bound-type_      (The generics parameter is bounded)
 
 _bound-type_ ::= _class-name_ _type-arguments_       (Class instance type)
-              | _interface-name_ _type-arguments_    (Interface type)
-              | `singleton(` _class-name_ `)`        (Class singleton type)
+               | _interface-name_ _type-arguments_   (Interface type)
+               | `singleton(` _class-name_ `)`       (Class singleton type)
 
 _generics-variance_ ::=               (Invariant)
                       | `out`         (Covariant)
@@ -607,8 +652,8 @@ class Array[out T]
 end
 ```
 
-There's a limitation with this is for mutable objects (like arrays): a mutation could invalidate this.
-If an array of `String` is passed to a method as an array of `Objects`, and that method adds an Integer to the array, the promise is broken.
+There's a limitation with this for mutable objects (like arrays): a mutation could invalidate this.
+If an `Array` of `String` is passed to a method as an `Array` of `Object`, and that method adds an `Integer` to the `Array`, the promise is broken.
 
 In those cases, one must use the `unchecked` keyword:
 

data/docs/tools.md

@@ -0,0 +1,16 @@
+# Tools
+
+This documentation describes major tools related to RBS. They are listed alphabetically.
+
+## Type Checkers
+
+* [Steep](https://github.com/soutaro/steep) is a static type checker based on RBS. You can use it as a language server integrated with an editor or IDE and run it from the command line.
+* [TypeProf](https://github.com/ruby/typeprof)
+
+## Editor integrations
+
+* Emacs: [rbs-mode](https://github.com/ybiquitous/rbs-mode)
+* RubyMine: [It supports RBS by default](https://www.jetbrains.com/help/ruby/rbs.html)
+* Sublime Text: [sublime-rbs-plugin](https://github.com/soutaro/sublime-rbs-plugin)
+* Vim: [rbs.vim](https://github.com/pocke/rbs.vim)
+* Visual Studio Code: [vscode-rbs-syntax](https://github.com/soutaro/vscode-rbs-syntax)