Branch: refs/heads/blead
Home: https://github.com/Perl/perl5
Commit: 12a46113754babfa76b4008816f106477babc53b
https://github.com/Perl/perl5/commit/12a46113754babfa76b4008816f106477babc53b
Author: Lukas Mai <lukasmai....@gmail.com>
Date: 2023-09-05 (Tue, 05 Sep 2023)
Changed paths:
M pod/perl.pod
Log Message:
-----------
perl.pod: use spaces instead of tabs for alignment
On some platforms/formatters, the documentation overview in 'perldoc
perl' renders badly (misaligned) because tabs are interpreted
differently. This is presumably because some renderers output all of the
leading spaces in a verbatim paragraph as-is, while others don't.
For example, https://perldoc.perl.org/perl currently shows for me:
|
v
...
perlsyn Perl syntax
perldata Perl data structures
perlop Perl operators and precedence
perlsub Perl subroutines
perlfunc Perl built-in functions
perlopentut Perl open() tutorial
perlpacktut Perl pack() and unpack() tutorial
perlpod Perl plain old documentation
perlpodspec Perl plain old documentation format specification
perldocstyle Perl style guide for core docs
perlpodstyle Perl POD style guide
perldiag Perl diagnostic messages
perldeprecation Perl deprecations
perllexwarn Perl warnings and their control
perldebug Perl debugging
perlvar Perl predefined variables
...
^
|
All of the "Perl"s in the second column should be aligned like the
"perldeprecation" line, which is the only one that uses spaces in the
original POD document (the others use either one tab, two tabs, or a mix
of spaces and tabs).
By using spaces everywhere we bypass the whole issue and get
consistently aligned results, no matter how tabs are rendered.
