Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Reduce POD warnings and errors #58

Closed
wants to merge 5 commits into from
Closed

Reduce POD warnings and errors #58

wants to merge 5 commits into from

Conversation

paultcochrane
Copy link
Contributor

These changes fix all errors and most warnings thrown by podchecker.

Comments and feedback are most certainly welcome.

Paul Cochrane added 5 commits June 12, 2015 12:59
Add space after =cut statement
94cbc3d 
This corrects the 'Spurious text after =cut' errors found by podchecker.
Remove empty =over blocks
4646fca 
This removes the 'No items in =over' warning from podchecker
Escape slash char inside POD link
c6d070f 
Inside POD links (L<>), one needs to escape special characters such
as / and |.  This change replaces the slash char in the link with
its relevant POD escape: E<sol>.  Admittedly this is hard to read
in the plain text, however the generated link correctly jumps to
its target and podchecker doesn't complain so much.
Add a DESCRIPTION to SQL::Translator::Filter::Names
eef0c99
Replace sectioned links with C<> formatting
5f8797a 
Using L<> for sectioned links (e.g. L<perl(1)>) is deprecated.  The
Pod::Checker docs state that "POD hyperlinks may point to POD documents
only."  This change also removes a warning from podchecker.
@ribasushi
Copy link
Contributor

Any chance of following this with an xt/pod.t test, so that a PR like this is never needed again? If in doubt - steal the one from DBIC.

Thanks!

@paultcochrane
Copy link
Contributor Author

Sure, no worries! I've got a couple of other ideas which would probably fit well with such a test, so let's keep this PR on ice until I've gotten the other code written.

@ribasushi
Copy link
Contributor

@paultcochrane In the meantime I have applied 94cbc3d, 4646fca and 5f8797a
as
33d693c, f60d4c6 and 0e9badb respectively.

The remaining 2 commits in this PR will stay on ice until you get back to this.

@ribasushi
Copy link
Contributor

As per short IRC conversation this PR will be closed with no further action. The outstanding work is resolved as follows:
c6d070f - The slashes within L<> headings will not be converted to E<> sequences. A future xt/ test will make steps to explicitly ignore this warnings as it is of no practical consequence.
eef0c99 - Seems like a botched partial commit, will be resubmitted as a separate PR

@ribasushi
Copy link
Contributor

@paultcochrane let me know if I missed something ;)

@ribasushi ribasushi closed this Jun 25, 2015
@paultcochrane
Copy link
Contributor Author

@ribasushi looks good :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
patch_needs_work
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@paultcochrane @ribasushi