[ruby/error_highlight] Add some comments

https://github.com/ruby/error_highlight/commit/e0c90c72c3

1 files changed, 5 insertions, 1 deletions

diff --git a/lib/error_highlight/core_ext.rb b/lib/error_highlight/core_ext.rb
index ad1c15a485..0ca2d1301a 100644
--- 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 @@ module ErrorHighlight
 
   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