summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2022-03-30 09:56:03 -0600
committerKarl Williamson <khw@cpan.org>2022-03-30 10:18:08 -0600
commit3b4e20eb6eae9f8f34de1b0c332987ae68417741 (patch)
tree6b0816f485f4b290de7ae9d21df5fe123fb0271f
parentd087776a447524d7ce4416394986c6b535067ee6 (diff)
downloadperl-3b4e20eb6eae9f8f34de1b0c332987ae68417741.tar.gz
podcheck.t: Update pod about verbatim lines
-rw-r--r--t/porting/podcheck.t11
1 files changed, 6 insertions, 5 deletions
diff --git a/t/porting/podcheck.t b/t/porting/podcheck.t
index 22abfba8c0..21edd33ee4 100644
--- a/t/porting/podcheck.t
+++ b/t/porting/podcheck.t
@@ -111,12 +111,13 @@ The pedantic checks are:
=over
-=item Verbatim paragraphs that wrap in an 80 (including 1 spare) column window
+=item Verbatim paragraphs that wrap in an 80 (including 2 spare) column window
-It's annoying to have lines wrap when displaying pod documentation in a
-terminal window. This checks that all verbatim lines fit in a standard 80
-column window, even when using a pager that reserves 2 columns for its own
-use. (Thus the check is for a net of 78 columns.)
+Pod that inappropriately wraps is less legible. Pod formatters generally wrap
+correctly, except for too long verbatim lines. We assume that any display
+window has at least the traditional 80 columns, and check for verbatim lines
+that won't fit in that space, including when using a pager that reserves 2
+columns for its own use. (Thus the check is for a net of 78 columns.)
For those lines that don't fit, it tells you how much needs to be cut in
order to fit.