Merge pull request #902 from ruby/test-annotations

Test annotations

.github/workflows/comments.yml

@@ -0,0 +1,34 @@
+name: RBS Comments
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    container:
+      image: rubylang/ruby:3.1-focal
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        apt-get update
+        apt-get install -y libdb-dev
+    - 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 annotate confirm_annotation

Rakefile

@@ -34,6 +34,15 @@ rule ".c" => ".re" do |t|
   puts "⚠️⚠️⚠️ #{t.name} is older than #{t.source}. You may need to run `rake lexer` ⚠️⚠️⚠️"
 end
 
+task :annotate do
+  sh "rbs annotate core stdlib"
+end
+
+task :confirm_annotation do
+  puts "Testing if RBS docs are updated with respect to RDoc"
+  sh "git diff --exit-code core stdlib"
+end
+
 task :compile => "ext/rbs_extension/lexer.c"
 
 task :test_doc do
@@ -126,7 +135,7 @@ namespace :generate do
       def to_s
         @type_name.to_s
       end
-      
+
       def absolute_type_name
         @absolute_type_name ||= @type_name.absolute!
       end
@@ -223,7 +232,7 @@ namespace :generate do
           :~   => 'tilde'
         }.fetch(method_name, method_name)
       end
-      
+
       def class_methods
         @class_methods ||= RBS::DefinitionBuilder.new(env: env).build_singleton(target.absolute_type_name).methods.select {|_, definition|
           definition.implemented_in == target.absolute_type_name

core/encoding.rbs

@@ -894,6 +894,7 @@ class Encoding::Converter < Object
                       | :destination_buffer_full
                       | :source_buffer_empty
                       | :finished
+
   # <!--
   #   rdoc-file=transcode.c
   #   - Encoding::Converter.asciicompat_encoding(string) -> encoding or nil