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 warnings #15

Merged
merged 6 commits into from Mar 21, 2018

Conversation

Projects
None yet
2 participants
@paultcochrane
Contributor

paultcochrane commented Mar 20, 2018

podchecker produced several warnings; most were (effectively) due to missing method documentation. The commits in this PR adapt the POD to conform to the relevant standards and adds missing docs where possible. It's probably a good idea to check that I've definitely understood what the code does, so that the docs match the code properly!

paultcochrane added some commits Mar 20, 2018

Move run() method POD to main docs section
`podchecker` noticed that the `=head2` was missing a preceding `=head1`;
upon closer inspection it seemed that the POD for the `run()` method
should have been part of the main documentation section which is at the
end of the file.  Moving the docs for `run()` to the main section fixes
the podchecker warning and puts the docs for this file all in the one
location.
Make SWISH_DOC_PROP_MAP heading into an item
Since, in the given context, it's an item in list.  This also fixes a
podchecker warning about an empty paragraph under the heading.
Add missing docs for SWISH-related methods
Some of the docs were missing for SWISH-related methods.  The text used
here for each of the items is taken from the SWISH-e source code.

@karpet karpet merged commit 3639c4d into karpet:master Mar 21, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@paultcochrane paultcochrane deleted the paultcochrane:pr/fix-pod-warnings branch Mar 21, 2018

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