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

CPAN Pull Request Challenge #3

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
2 participants
@pauloscustodio
Contributor

pauloscustodio commented Jun 2, 2015

Pull requests in the context of the CPAN Pull Request Challenge

pauloscustodio added some commits Jun 2, 2015

Add test script to check for POD errors
Add t/92_pod.t that calls Test::Pod's all_pod_files_ok().
Test is skipped if Test::Pod is not available.
Added MIN_PERL_VERSION to improve Kwalitee scores
http://cpants.cpanauthors.org/dist/List-Compare suggests the addition of MIN_PERL_VERSION
Perl::MinimumVersion was used to determine 5.6 as the minimum required version for
all distribution modules.

@pauloscustodio pauloscustodio changed the title from Add test script to check for POD errors to CPAN Pull Request Challenge Jun 2, 2015

@jkeenan

This comment has been minimized.

Show comment
Hide comment
@jkeenan

jkeenan Jun 2, 2015

Owner

Thanks for taking the time to prepare this pull request. However, I'm not going to accept it. I have always disliked Test::Pod and Test::Pod::Coverage since they tend to enforce one particular style of writing POD. I considered using them in my CPAN distributions ten years ago and concluded that they were more trouble than they are worth. In particular, unless one goes into the Makefile or Build file and specifies POD tests as "author-only", then any failures in POD formatting or failures to write POD for some specific section run the risk of having 'make test' fail -- failures which would then show up as red ink on cpantesters.org.

I am, however, very willing to accept pull requests or patches for actual POD formatting errors. Thank you very much.

Owner

jkeenan commented Jun 2, 2015

Thanks for taking the time to prepare this pull request. However, I'm not going to accept it. I have always disliked Test::Pod and Test::Pod::Coverage since they tend to enforce one particular style of writing POD. I considered using them in my CPAN distributions ten years ago and concluded that they were more trouble than they are worth. In particular, unless one goes into the Makefile or Build file and specifies POD tests as "author-only", then any failures in POD formatting or failures to write POD for some specific section run the risk of having 'make test' fail -- failures which would then show up as red ink on cpantesters.org.

I am, however, very willing to accept pull requests or patches for actual POD formatting errors. Thank you very much.

@jkeenan jkeenan closed this Jun 2, 2015

@pauloscustodio

This comment has been minimized.

Show comment
Hide comment
@pauloscustodio

pauloscustodio Jun 3, 2015

Contributor

I agree with you in what respects Test::Pod::Coverage, as it forces you to write a section for each module method. I have included it in some of my own distributions, but yor're right when you say it's too much trouble to keep it passing the tests.

I do not agree in respect to Test::Pod, as it only tests for syntax errors in the POD files, which are too easy to slip by and end up in a CPAN distribution. The pull request I have submitted, BTW, passes the tests at the current master HEAD, and fails the tests before the POD fix of Pull Request #2, so it would have avoided the "1 POD Error" message at the end of https://metacpan.org/pod/List::Compare in the current CPAN version of your module.

Of course, this is just my opinion, and you are free to accept or not my reasoning.

Contributor

pauloscustodio commented Jun 3, 2015

I agree with you in what respects Test::Pod::Coverage, as it forces you to write a section for each module method. I have included it in some of my own distributions, but yor're right when you say it's too much trouble to keep it passing the tests.

I do not agree in respect to Test::Pod, as it only tests for syntax errors in the POD files, which are too easy to slip by and end up in a CPAN distribution. The pull request I have submitted, BTW, passes the tests at the current master HEAD, and fails the tests before the POD fix of Pull Request #2, so it would have avoided the "1 POD Error" message at the end of https://metacpan.org/pod/List::Compare in the current CPAN version of your module.

Of course, this is just my opinion, and you are free to accept or not my reasoning.

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