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
guest20
reviewed
May 6, 2025
khwilliamson
force-pushed
the
escape
branch
2 times, most recently
from
ede7f9d to
8d8d490
Compare
Grinnz
reviewed
May 6, 2025
Grinnz
reviewed
May 6, 2025
This adds a bit of text about metacharacters that was missing from this introductory pod.
Fixes Perl#15221 The documentation and comments were 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. This also adds a note that quotemeta isn't affected by locale.
Grinnz
reviewed
May 7, 2025
| Today it is more common to use the C<L<quotemeta()|perlfunc/quotemeta>> | ||
| (If C<use locale> is in effect, then this depends on the current locale.) | ||
|
|
||
| This template used to be a common paradigm, but these days it is more |
There was a problem hiding this comment.
It's not really the purpose of this PR, but I think it's a little misleading to say that quotemeta "disables metacharacters special meanings" without also saying that it actually does a very similar thing to the example just above, without being locale dependent for ASCII characters. i.e. it's exactly equivalent to s/([^A-Za-z_0-9])/\\$1/g or s/(\W)/\\$1/ag for ASCII characters (with behavior on non-ASCII characters dependent on the unicode_strings feature).
There was a problem hiding this comment.
With the additional very useful feature that it can be interpolated with \Q and \E rather than applied to the whole pattern.
Grinnz
approved these changes
May 7, 2025
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.