Repository navigation
fix(perl): count POD that opens with a heading - #788
Open
LuisFigueroaG wants to merge 1 commit into
Open
LuisFigueroaG wants to merge 1 commit into
LuisFigueroaG wants to merge 1 commit into
Conversation
pr-insights
Bot
added
M/complexity
This branch has not been deployed
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
1 participant
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.
In Perl, a POD command at the start of a statement starts a POD block that runs until
=cut. scc only recognised=pod, but most POD starts with a heading (=head1 NAME), so all of that documentation was counted as code.This adds
=head1to=head4as openers that close on=cut, and regeneratesprocessor/constants.go. On the system Perl library on macOS (1,254 files), code goes from 568,483 to 486,160 lines and comments from 56,449 to 158,230.There's one limitation, which
=podalready has: openers aren't tied to the start of a line, so a regex likem/^=head1 NAME/in POD-parsing code also opens a block. That happened in 6 of those 1,254 files, all of them Pod tooling. I stopped at the headings because shorter commands like=itemand=overwould also match code like$x=items.Tests are in
processor/workers_perl_test.go: blocks that start with a heading fail on master, and another test checks that=podstill works../test-all.shpasses.I explicitly license this contribution under the MIT licence.