Fix POD errors warnings #27
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes fix issues found by
podchecker. Comments and questions are most certainly welcome.