From: Steve Hancock <perltidy@users.sourceforge.net>
Date: Tue, 22 Sep 2020 00:20:29 +0000 (-0700)
Subject: update docs
X-Git-Tag: 20201001~19
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=96206d13156bde9494c8dc6a52b57a33c6d6aebe;p=perltidy.git

update docs
---

diff --git a/CHANGES.md b/CHANGES.md
index 85748299..b076d162 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -12,7 +12,7 @@
 
     - Numerous issues have been found during automated testing and fixed. Many involve references to
       uninitialized variables when perltidy is given random text. A complete list is given in
-      the file 'BugLog.pod'.
+      the file [BugLog.pod](https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod).
 
 ## 2020 09 07
 
diff --git a/local-docs/BugLog.pod b/local-docs/BugLog.pod
index 46094a3e..ccbe6d9f 100644
--- a/local-docs/BugLog.pod
+++ b/local-docs/BugLog.pod
@@ -5,6 +5,13 @@ found with the help of automated random testing.
 
 =over
 
+=item B<If an =cut starts a POD section within code, give a warning>
+
+Previously only a complaint was given, which went into the log file and was not normally
+seen.  Perl silently accepts this but it can cause significant problems with pod utilities, so
+a clear warning is better.  This situation arose in testing on random files in combination with
+a -dp flag and it took some time to understand the results because of the lack of a warning.
+
 =item B<Switched from using an eval block to the ->can() function for sub finish_formatting>
 
 This is not a bug, but is cleaner coding and insures that error messages get reported.