pod and comments: Note escape vs quote #23264
Open
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
This adds a bit of text about metacharacters that was missing from this introductory pod.
guest20
reviewed
May 6, 2025
Fixes Perl#15221 The documentation and comments was misleading about conflating quoting a metacharacter and escaping it. Since \Q stands for quote, we have to continue to use that terminology. This commit clarifies that the two terms are often equivalent.
Grinnz
reviewed
May 6, 2025
| want to match on, where "thing" means either a literal character, one | ||
| of the metacharacters listed above, or a group of characters or | ||
| metacharacters in parentheses. | ||
| Note that in the above, C<$> doesn't mean a dollar sign. Similarly |
There was a problem hiding this comment.
Perhaps slightly clearer to say, "$ doesn't match a dollar sign."
There was a problem hiding this comment.
And if so, "mean" could be replaced with "match" to clarify some other statements in this section.
Grinnz
reviewed
May 6, 2025
| once used in a common idiom to disable or quote the special meanings | ||
| of regular expression metacharacters in a string that you want to | ||
| use for a pattern. Simply quote all non-"word" characters: | ||
| =head2 Quoting (or escaping) metacharacters |
There was a problem hiding this comment.
Changing headings is perilous, but I found no instances of this being linked to directly on CPAN.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #15221
The documentation and comments was misleading about conflating quoting a metacharacter and escaping it. Since \Q stands for quote, we have to continue to use that terminology. This commit clarifies that the two terms are often equivalent.