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

Minor POD fixes #38

Open
wants to merge 4 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@paultcochrane

paultcochrane commented May 27, 2016

This PR corrects some grammatical errors, makes the code-like text formatting more consistent and removes podchecker warnings.

The PR is submitted in the hope that it is useful. If you have any questions or comments concerning it, please don't hesitate to ask! If you wish for the commits to be changed or updated, just let me know and I'll fix and resubmit.

paultcochrane added some commits May 27, 2016

Simplify method documentation text
This change also makes the wording more consistent with the usage in the
rest of the distribution: instead of repeating the name of the method in the
documentation text, one merely needs to say what it does, hence the
duplicated information has been removed from the docs.
Format code-like POD more consistently in docs
This change tries to ensure that code-like text elements in POD are
formatted consistently.  Having code-like text be formatted in a monospace
font helps reading documentation when presented on e.g. MetaCPAN.
Add docs to empty paragraphs in POD
`podchecker` was throwing warnings that some paragraphs were empty.  The
missing documentation has been added and `podchecker` gives no more
warnings.  Admittedly this duplicates some documentation text, however it
seems to make the documentation easier to read for the specific methods
involved.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment