perlapi: Improve wording of plain/nocontext entries #23757
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
mauke
reviewed
Sep 23, 2025
autodoc.pl
Outdated
Comment on lines
1779
to
1784
| while ($pod =~ / ( __PLAIN_vs_NOCONTEXT_wording__ \( (\w+) \) ) /x) { | ||
| my $entire = $1; | ||
| my $this = $2; | ||
| $this = $PLAIN_vs_NOCONTEXT_wording =~ s/WHICH/$this/gr; | ||
| $pod =~ s/\Q$entire/$this/; | ||
| } |
Contributor
There was a problem hiding this comment.
Why loop and match (and re-match) manually?
Suggested change
| while ($pod =~ / ( __PLAIN_vs_NOCONTEXT_wording__ \( (\w+) \) ) /x) { | |
| my $entire = $1; | |
| my $this = $2; | |
| $this = $PLAIN_vs_NOCONTEXT_wording =~ s/WHICH/$this/gr; | |
| $pod =~ s/\Q$entire/$this/; | |
| } | |
| $pod =~ s{ \b __PLAIN_vs_NOCONTEXT_wording__ \( (\w+) \) }{ | |
| my $this = $1; | |
| $PLAIN_vs_NOCONTEXT_wording =~ s/WHICH/$this/gr | |
| }xeg; |
Certain functions have forms that contain the suffix '_nocontext', and which have long been specially handled in embed.h. autodoc was unaware of these until 14c379e recently. This tweaks the wording added in that commit, and by changing to use an in-line marker where its desired in the pod instead of an arbitrary place dictated from above, makes the result flow better.
khwilliamson
force-pushed
the
autodoc_nocontext
branch
from
931a26d to
1eb706e
Compare
tonycoz
approved these changes
Sep 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Certain functions have forms that contain the suffix '_nocontext', and which have long been specially handled in embed.h. autodoc was unaware of these until 14c379e recently.
This tweaks the wording added in that commit, and by changing to use an in-line marker where its desired in the pod instead of an arbitrary place dictated from above, makes the result flow better.