Merged
Conversation
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.
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.
`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.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR corrects some grammatical errors, makes the code-like text formatting more consistent and removes
podcheckerwarnings.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.