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 podchecker issues #6

Merged
merged 3 commits into from Oct 7, 2016

Conversation

Projects
None yet
2 participants
@paultcochrane
Contributor

paultcochrane commented Sep 26, 2016

This PR corrects warnings and errors discovered by podchecker. I've split up the fixes quite thinly so that the individual commits can be cherry picked as required. If you have any questions or comments concerning the PR, please just let me know! The PR is intended to be helpful, so if anything needs to be changed, then I will happily update it and resubmit.

paultcochrane added some commits Sep 25, 2016

Fix "spurious =cut command" podchecker error
For the code to be correct POD, the `=head2` needs to have a blank line
between the preceding code section and itself.  This change fixes the error
reported by podchecker.
Fix "line with only whitespace" podchecker warnings
POD best practice recommends that lines should not contain only whitespace.
This change removes the offending whitespace, thus removing the warning
reported by podchecker.
Fix POD type mismatch in item list
`podchecker` noticed a type mismatch in the item list altered in this
change.  The reason being that the first item, "-1", as an argument to
`=item` is interpreted by POD formatters as a definition section, whereas
the second item, "0", is interpreted as a number.  The solution presented
here removes the item list, reduces the amount of text and reflects a
similar text segment in the POD of the following section (the docs for
`openpage()`).  This change thus tries to remain consistent with the current
documentation style.
@ssimms

This comment has been minimized.

Show comment
Hide comment
@ssimms

ssimms Oct 7, 2016

Owner

Thanks for these fixes.

Owner

ssimms commented Oct 7, 2016

Thanks for these fixes.

@ssimms ssimms merged commit 5fd13b8 into ssimms:master Oct 7, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment