Fix conflict with Dist::Zilla::Plugin::PodCoverageTests

[greencoloured]

This module was causing the PodCoverageTests to fail as it was being detected and did not have any pod. To fix this I've made the existing comment into a Pod exception for the file.

[karenetheridge]

=for *EVERYTHING* looks a bit odd -- how is this being parsed by the pod checker?

[greencoloured]

Dist::Zilla::Plugin::PodCoverageTests uses the Pod::Coverage::TrustPod module that define "trusted" pod for symbols using blocks like:

=begin Pod::Coverage

foo

=end Pod::Coverage

or

=for Pod::Coverage foo

It also defines the special pattern *EVERYTHING* to mean everything in the file to be trusted as covered. I'm afraid I misread the module's docs and didn't realise that the Pod::Coverage bit was required. The file passed anyway as it looks like all that is required for this file to pass is that it have any pod at all.

Though I still think the proper line should be included:

=for Pod::Coverage *EVERYTHING*

Meaning "for pod coverage everything in this file should be trusted".

Would you like the pull request updated?

[greencoloured]

Another option would be to simply provide some pod and, should there be any changes later that require more coverage, reconsider.

Something like:

diff --git a/lib/Dist/Zilla/Plugin/Conflicts.pm b/lib/Dist/Zilla/Plugin/Conflicts.pm
index 5922efd..30c0db0 100644
--- a/lib/Dist/Zilla/Plugin/Conflicts.pm
+++ b/lib/Dist/Zilla/Plugin/Conflicts.pm
@@ -127,7 +127,11 @@ package # hide from PAUSE
 use strict;
 use warnings;
 
-# this module was generated with {{ ref($plugin) . ' ' . ($plugin->VERSION || '<self>') }}
+=pod
+
+this module was generated with {{ ref($plugin) . ' ' . ($plugin->VERSION || '<self>') }}
+
+=cut
 
 use Dist::CheckConflicts
     -dist      => '{{ $dist_name }}',

[karenetheridge]

I think it might be better to just provide some pod. @autarch is there anything specific you think should go in here? I'm figuring a very simple paragraph explaining the purpose of the module should be sufficient, and clarification that it is for internal use only (which is why we never had any pod to begin with). @greencolored also note I've pushed a few commits to master, which should fix the travis failures.

…

On Thu, Sep 13, 2018 at 4:11 AM, greencoloured ***@***.***> wrote: Another option would be to simply provide some pod and, should there be any changes later that require more coverage, reconsider. Something like: diff --git a/lib/Dist/Zilla/Plugin/Conflicts.pm b/lib/Dist/Zilla/Plugin/Conflicts.pm index 5922efd..30c0db0 100644--- a/lib/Dist/Zilla/Plugin/Conflicts.pm+++ b/lib/Dist/Zilla/Plugin/Conflicts.pm@@ -127,7 +127,11 @@ package # hide from PAUSE use strict; use warnings; -# this module was generated with {{ ref($plugin) . ' ' . ($plugin->VERSION || '<self>') }}+=pod++this module was generated with {{ ref($plugin) . ' ' . ($plugin->VERSION || '<self>') }}++=cut use Dist::CheckConflicts -dist => '{{ $dist_name }}', — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#9 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AASfy11kvuBAJ7qVmGEoXI5cliJbRYhHks5uaj1XgaJpZM4WlNIm> .

[autarch]

Yes, a bit of POD saying what this module is for and how it was generated would be ideal.

[autarch]

@karenetheridge I pushed some changes to master that add some pod. Can you take a look?

[karenetheridge]

This looks good. The distribution hasn't been released in a while -- how do you feel about doing that?

[autarch]

I just released v0.20. I will close this PR since the bug it addresses should now be fixed.

[karenetheridge]

thanks!