Add some comments

ruby · Jun 30, 2021 · e0c90c7 · e0c90c7
1 parent bcfce4c
commit e0c90c7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lib/error_highlight/core_ext.rb b/lib/error_highlight/core_ext.rb
@@ -1,5 +1,8 @@
 module ErrorHighlight
   module CoreExt
+    # This is a marker to let `DidYouMean::Correctable#original_message` skip
+    # the following method definition of `to_s`.
+    # See https://github.com/ruby/did_you_mean/pull/152
     SKIP_TO_S_FOR_SUPER_LOOKUP = true
     private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
 
@@ -42,7 +45,8 @@ def to_s
 
   NameError.prepend(CoreExt)
 
-  # temporarily disabled
+  # The extension for TypeError/ArgumentError is temporarily disabled due to many test failures
+
   #TypeError.prepend(CoreExt)
   #ArgumentError.prepend(CoreExt)
 end