From: Steve Hancock <perltidy@users.sourceforge.net>
Date: Fri, 20 Nov 2020 17:38:36 +0000 (-0800)
Subject: update docs
X-Git-Tag: 20201202~25
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=5e43dfeb7f7560b0505c276d10d57369a9b3ffcc;p=perltidy.git

update docs
---

diff --git a/lib/Perl/Tidy/VerticalAligner.pm b/lib/Perl/Tidy/VerticalAligner.pm
index 5ffae066..02759fce 100644
--- a/lib/Perl/Tidy/VerticalAligner.pm
+++ b/lib/Perl/Tidy/VerticalAligner.pm
@@ -1307,8 +1307,8 @@ sub check_fit {
     my ( $self, $new_line, $old_line ) = @_;
 
     # The new line has alignments identical to the current group. Now we have
-    # to fit the new line into the group without causing a field
-    # to exceed the line length limit.
+    # to fit the new line into the group without causing a field to exceed the
+    # line length limit.
     #   return true if successful
     #   return false if not successful
 
@@ -1318,8 +1318,10 @@ sub check_fit {
     my $padding_available   = $old_line->get_available_space_on_right();
     my $jmax_old            = $old_line->get_jmax();
 
-    # safety check ... only lines with equal array lengths should arrive here
-    # from sub check_match
+    # Safety check ... only lines with equal array sizes should arrive here
+    # from sub check_match.  So if this error occurs, look at recent changes in
+    # sub check_match.  It is only supposed to check the fit of lines with
+    # identical numbers of alignment tokens.
     if ( $jmax_old ne $jmax ) {
 
         $self->warning(<<EOM);
diff --git a/local-docs/Release-Checklist.md b/local-docs/Release-Checklist.md
index a9c78959..5c236b28 100644
--- a/local-docs/Release-Checklist.md
+++ b/local-docs/Release-Checklist.md
@@ -5,7 +5,7 @@
 - compare formatting with the new version with previous version on all files in test area
 - run a blinker test (activate option -I and look for 'Blinker' in DIAGNOSTICS)
 - run a timing test: compare run time with previous version
-- profile with 'nytprof' with different parameters and compare with previous version: For example
+- profile with Devel::NYTProf with different parameters and compare with previous version: For example
   perl -d:NYTProf perltidy.pl -pbp -nst -nse -wn -xci perltidy.pl
   nytprofhtml --open
 - run random testing on final version for a significant time before releasing (several days)
@@ -29,11 +29,11 @@
 - run podchecker on all .pod files
 - run ispell on all .pod files
 - Be sure builds at Travis.CI and Appveyor are clean for all version of perl
-- update VERSION numbers in these files (build.pl can do this):
+- update VERSION numbers in all modules and some docs (build.pl can do this):
    - lib/Perl/Tidy.pm
    - lib/Perl/Tidy.pod
    - bin/perltidy
-   - local-docs/ChangeLog.pod
+   - CHANGES.md
 - make manifest
     - check MANIFEST over very carefully
     - sometimes it is necessary to remove MANIFEST and then do "make manifest"
@@ -43,7 +43,7 @@
    - make test
    - make dist
 - *IMPORTANT:* Now untar the file (perhaps in /tmp) and take a look at the
-  contents.  Be sure it does not have unwanted stuff
+  contents.  Be sure it does not have unwanted files.
    - If necessary, remove MANIFEST, fix MANIFEST.SKIP and run make manifest again
 - Do test installs on several systems 
 - Upload Release to CPAN