t/porting/podcheck.t: allow ' in English words #23135
Merged
Conversation
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
podcheck.t uses a crude heuristic to identify links that use the wrong
POD syntax (e.g. C<Some::Module> instead of L<Some::Module>): It checks
whether the word before the C<...> markup was "see". This has the
potential for a lot of false positives, so it adds an additional check:
If the words before "see" include the word "you", we don't count it as a
link attempt. This is to rule out cases like "you may see C<mtfnpy> in
the output".
However, that heuristic failed on this example from perlport:
on Unix you'll see C<"a.">
This is because ' is not a word character, so the leading context was
just "ll", which doesn't contain "you":
not ok 241 - POD of pod/perlport.pod
# "? Should you be using L<...> instead of"
# C<"a."> near line 1104 of pod/perlport.pod
This patch teaches podcheck.t about common English short forms such as
"you'll", "you're", or "you'd".
khwilliamson
approved these changes
Mar 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
podcheck.t uses a crude heuristic to identify links that use the wrong POD syntax (e.g.
C<Some::Module>instead ofL<Some::Module>): It checks whether the word before theC<...>markup was "see". This has the potential for a lot of false positives, so it adds an additional check: If the words before "see" include the word "you", we don't count it as a link attempt. This is to rule out cases likeyou may see C<mtfnpy> in the output.However, that heuristic failed on this example from perlport:
This is because ' is not a word character, so the leading context was just "ll", which doesn't contain "you":
This patch teaches podcheck.t about common English short forms such as "you'll", "you're", or "you'd".