update docs

diff --git a/CHANGES.md b/CHANGES.md
index 6909225b6c75fdbfceb405b498a383e2afa54e3c..fa975bbe6c2046643af0c42c12193263f3ff924c 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -5,8 +5,9 @@
     - Add parameter --closing-side-comment-exclusion-list=string, or
       -cscxl=string, where string is a list of block types to exclude
       for closing side comment operations.  Also, closing side comments
-      now work for anonymous subs.  Use -cscxl=asub if you do not
-      want this.
+      now work for anonymous subs if a --closing-side-comment-list (-cscl)
+      is not specified, and when 'asub' is requested with -cscl=asub.
+      Use -cscxl=asub to prevent this.
 
     - Include signature variables in --dump-unusual-variables and
       --warn-variable-types; see git #158.
@@ -19,13 +20,13 @@
       is now "state ($x)". This space can be removed with -nsak='state'.
 
     - Add options --add-lone-trailing-commas, -altc and
-      --delete-lone-trailing-commas, -dltc, to add control over adding
+      --delete-lone-trailing-commas, -dltc, to provide control over adding
       and deleting the only comma in a list.  See discussion in git #143
       and the updated manual.
 
     - Add options --dump-mismatched-returns (or -dmr) and
       --warn-mismatched-returns (or -wmr).  These options report function
-      calls where the number of requested values may disagree with sub
+      calls where the number of values requested may disagree with sub
       return statements.  The -dump version writes the results for a single
       file to standard output and exits:
 
@@ -42,30 +43,31 @@
       --warn-mismatched-return-types=s (or -wmrt=s),
       --warn-mismatched-return-exclusion-list=s (or -wmrxl=s)
 
-      These are explained in the manual.
+      where 's' is a control string. These are explained in the manual.
 
     - Updates for issue git #151:
       (1) --warn-variable-types=u is now okay if it is on the command line
       with a named file.
       (2) --warn-variable-exclusion-list=s now allows leading and/or
       trailing * on variable names to allow a wildcard match. For example
-      -wvxl='*_unused' is okay.
+      -wvxl='*_unused' is okay and would match $var1_unused and $var2_unused.
       (3) --dump-unusual-variables now outputs the filename.
 
     - A option was added to filter unimplemented parameters from perltidy
-      configuration files, suggested in git #146.  If a line in the config
-      file begins with three dashes followed by a parameter name
-      (rather than two), then the line will be removed if the parameter is
-      unknown. Otherwise, a dash will be removed to make the line valid.
+      configuration files, suggested in git #146.  It works like this: if
+      a line in the config file begins with three dashes followed by a
+      parameter name (rather than two), then the line will be removed if
+      the parameter is unknown. Otherwise, a dash will be removed to make
+      the line valid.
 
     - Parameters --dump-mismatched-args (or -dma) and
       --warn-mismatched-args (or -wma) have been updated to catch more
       arg count issues.
 
-    - Fix issue git #143, extend -add-trailing-commas to apply to a list
+    - Fixed issue git #143, extend -add-trailing-commas to apply to a list
       with just a fat comma.
 
-    - Fix issue git #142, test failure installing on perl versions before
+    - Fixed issue git #142, test failure installing on perl versions before
       version 5.10.  The error caused the new parameter
       -interbracket-arrow-style=s not to work. Except for this limitation,
       Version 20240511 will work on older perl versions.

diff --git a/bin/perltidy b/bin/perltidy
index 6c5c776e33565f1b6b34b2fc90c76ee82e552930..d771dc06a54f80d5fb9dfc639906932a897fe88e 100755 (executable)
--- a/bin/perltidy
+++ b/bin/perltidy
@@ -6386,9 +6386,9 @@ These issue types are illustrated with the following code
         return ( $name, $flags );  # 2 values with 'return' statement
     }
 
-    ( $name, $flags, $access) = $self->wimp(); # 'o' (want array 3 > 2)
-    ($name) = $self->wimp();                   # 'u' (want array 1 < 2)
-    $name   = $self->wimp();                   # 's' (want scalar but 2 values returned)
+    ( $name, $flags, $access) = wimp(); # 'o' (want array 3 > 2)
+    ($name) = wimp();                   # 'u' (want array 1 < 2)
+    $name   = wimp();                   # 's' (want scalar but 2 values returned)
 
 This analysis works by scanning all call statements and all sub return
 statements, and comparing the the number of items wanted with the possible

diff --git a/local-docs/Release-Checklist.md b/local-docs/Release-Checklist.md
index c858c8c764878d4814a930962a9d9f9e638b8b8c..e9e9452f6e82df3e3d2662b96f48c1d13d1f50a9 100644 (file)
--- a/local-docs/Release-Checklist.md
+++ b/local-docs/Release-Checklist.md
@@ -33,7 +33,8 @@
   - The first line in Tidy.pm has the required version of Perl
   - use perlbrew to do local checks and debugging on earlier versions of perl
    - perlbrew list               [show installed versions]
-   - perlbrew available all      [show all available versions]
+   - perlbrew available --all    [show all available versions]
+     - or see https://www.cpan.org/src/README.html
    - perlbrew install perl-5.8.0 [install perl-5.8.0, may need to force]
    - perlbrew use perl-5.8.0     [switch to 5.8.0 in current shell]
 - Run tidyall -a to be sure code is tidied