From: Steve Hancock <perltidy@users.sourceforge.net>
Date: Mon, 16 Oct 2023 13:37:53 +0000 (-0700)
Subject: add clarifying comment
X-Git-Tag: 20230912.04~3
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=6a18c9b624155f38020d4cb949ed992649e936b9;p=perltidy.git

add clarifying comment
---

diff --git a/lib/Perl/Tidy/Logger.pm b/lib/Perl/Tidy/Logger.pm
index 0af825fd..a5031451 100644
--- a/lib/Perl/Tidy/Logger.pm
+++ b/lib/Perl/Tidy/Logger.pm
@@ -173,10 +173,14 @@ use constant MAX_PRINTED_CHARS => 35;
 
 sub black_box {
     my ( $self, $line_of_tokens, $output_line_number ) = @_;
+
+    # This routine saves information comparing the indentation of input
+    # and output lines when a detailed logfile is requested.
+    # This was very useful during the initial development of perltidy.
+
     my $input_line        = $line_of_tokens->{_line_text};
     my $input_line_number = $line_of_tokens->{_line_number};
 
-    # save line information in case we have to write a logfile message
     $self->{_line_of_tokens}                = $line_of_tokens;
     $self->{_output_line_number}            = $output_line_number;
     $self->{_wrote_line_information_string} = 0;