Fix POD warnings #15
Merged
Fix POD warnings #15
Conversation
added 6 commits
Mar 20, 2018
`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.
Since, in the given context, it's an item in list. This also fixes a podchecker warning about an empty paragraph under the heading.
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.
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.
podcheckerproduced 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!