Explain why class exists

ruby · Nov 15, 2024 · 8c36b0c · 8c36b0c
1 parent 9c78283
commit 8c36b0c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/syntax_suggest/mini_stringio.rb b/lib/syntax_suggest/mini_stringio.rb
@@ -5,6 +5,10 @@ module SyntaxSuggest
   #
   # Acts like a StringIO with reduced API, but without having to require that
   # class.
+  #
+  # The original codebase emitted directly to $stderr, but now SyntaxError#detailed_message
+  # needs a string output. To accomplish that we kept the original print infrastructure in place and
+  # added this class to accumulate the print output into a string.
   class MiniStringIO
     EMPTY_ARG = Object.new