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

Minor changes #8

Merged
merged 3 commits into from Jan 8, 2015

Conversation

Projects
None yet
3 participants
@fluca1978

fluca1978 commented Jan 7, 2015

This is my second pull request with minor changes to the implementation of Pod.pm.
Summary of changes: a few reqrites of internal method _is_perl and adjustment to documentation in order to be coherent between what is supposed to be a Perl/Pod file and the implementation.

fluca1978 added some commits Jan 3, 2015

Removed a mixed use of low and high precedence "and" operators.
Removed also an exra space in a method call.
Improved the _is_perl internal method following the suggestions of Da…
…vid, see #7

As suggested, the method should accept any file with a good suffix before trying to open it, we are sure it is a file from the finding subroutine.
All regular expressions are now using non-capturing groups, since there is no back reference used at all within any scope. All regular expressions dealing with file name (extensions) use the /x capability for better readibility.
If a file has not a well know suffix it will be tested against a shee
bang in the first line or, if it has a .bat suffix, it will be tested
against a --*-Perl-*-- first line.
Note that the MS Windows batch file extension is checked with the
ignore-case flag, while the *nix-like well know suffixes are not, since
it make sense to distinguish good cases .pl and .PL but not .Pl.
Added the description for batch files and for .PL files (as of _is_perl
implementation) to the documentation of the method
all_pod_files_ok.

This makes the documentation coherent behind with that of all_pod_files
and the implementation of internal method _is_perl.

@theory theory merged commit 58c928a into perl-pod:master Jan 8, 2015

@dolmen

This comment has been minimized.

Show comment
Hide comment
@dolmen

dolmen Jan 15, 2015

Here are some advices for the commit messages of your next PR:

  • use present tense: "Remove", "Improve", "Add"
  • all lines must be limited to 72 characters
  • the first line (72 chars) must be the summary of the whole message
  • second line must be empty
  • third and next lines contain details

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

dolmen commented Jan 15, 2015

Here are some advices for the commit messages of your next PR:

  • use present tense: "Remove", "Improve", "Add"
  • all lines must be limited to 72 characters
  • the first line (72 chars) must be the summary of the whole message
  • second line must be empty
  • third and next lines contain details

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

@fluca1978

This comment has been minimized.

Show comment
Hide comment
@fluca1978

fluca1978 Jan 16, 2015

Thanks for the suggestions, I'll take care of them!

fluca1978 commented Jan 16, 2015

Thanks for the suggestions, I'll take care of them!

@theory

This comment has been minimized.

Show comment
Hide comment
@theory

theory Jan 16, 2015

Too late for these commits (which I have released), but good for future reference. Thanks!

theory commented Jan 16, 2015

Too late for these commits (which I have released), but good for future reference. Thanks!

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