Update comments

Shopify · Jul 25, 2024 · c25bd71 · c25bd71
1 parent f965b8c
commit c25bd71
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb b/lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb
@@ -69,7 +69,9 @@ def handle_class_or_module_declaration(declaration, pathname)
           handle_method(member, entry)
         when RBS::AST::Declarations::Constant
           handle_constant(member, nesting, file_path)
-        when RBS::AST::Members::Alias # NOTE: This is a signature alias, not a Ruby method alias
+        when RBS::AST::Members::Alias
+          # In RBS, an alias means that two methods have the same signature.
+          # It does not mean the same thing as a Ruby alias.
           handle_signature_alias(member, entry)
         end
       end

diff --git a/lib/ruby_indexer/test/rbs_indexer_test.rb b/lib/ruby_indexer/test/rbs_indexer_test.rb
@@ -332,8 +332,8 @@ def self?.open: (String name, ?String mode, ?Integer perm) -> IO?
     end
 
     def test_signature_alias
-      # In RBS, an alias means that two methods have the same signature. It does not mean the same thing as a Ruby
-      # alias.
+      # In RBS, an alias means that two methods have the same signature.
+      # It does not mean the same thing as a Ruby alias.
       any_entries = @index["any?"]
 
       assert_equal(["Array", "Enumerable", "Hash"], any_entries.map { _1.owner.name })