New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix POD errors warnings #27

Open
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@paultcochrane

paultcochrane commented Sep 8, 2015

These changes fix issues found by podchecker. Comments and questions are most certainly welcome.

paultcochrane added some commits Sep 7, 2015

Fix internal link to CALLING COMPONENTS section
The full path to the section in the manual was needed in order to point to
the correct section.  The missing extra path caused the podchecker error:

    ERROR: unresolved internal link 'CALLING COMPONENTS' at line 210 in file ./lib/Mason/Component.pm
Remove superfluous whitespace in pod link
The extra whitespaced caused the podchecker warning:

    WARNING: ignoring trailing whitespace in link at line 57 in file ./lib/Mason/Plugin/LvalueAttributes.pm

This change removes the warning.
Fix non-escaped forward slash podchecker warning
POD parsers can have problems when forward slashes appear in the text part
of a POD link (`L<>`).  This change avoids the issue without changing the
sense of the sentence.  If one uses the advice in `Pod::Checker` for
handline this issue, one would have to use `PSGIE<sol>Plack` which is simply
too hard to read, although avoids the error while preserving the forward
slash.  In this case it seems that a hyphen is sufficient to retain the
meaning while avoiding any potential POD parser problems.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment