Fix RegexOptions.IgnorePatternWhitespace # to EOL #24936
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
The documentation currently states that
> All text in the regular expression pattern from the # character to the
> end of the string is interpreted as a comment.
when `RegexOptions.IgnorePatternWhitespace` is in effect. This omits
the fact that `#` behaves as a line comment when the pattern contains
multiple lines. It causes the text from `#` to the end of the line,
denoted by `\n`, to be interpreted as a comment. For example:
```csharp
using System.Text.RegularExpressions;
Console.WriteLine(Regex.Match(
"Hello World",
"Hello # Line Comment\n\\sWorld",
RegexOptions.IgnorePatternWhitespace));
```
Prints "Hello World", rather than "Hello" as it does if `\n` is removed
or replaced by `\r`.
This commit adds this behavior to the documentation.
Signed-off-by: Kevin Locke <[email protected]>
adegeo
added
the
✨ 1st-time docs contributor!
adegeo
approved these changes
Jul 6, 2021
|
My pleasure. Thanks for reviewing and merging @adegeo! |
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.
The Regular Expression Options documentation currently states that
when
RegexOptions.IgnorePatternWhitespaceis in effect. This omits the fact that#behaves as a line comment when the pattern contains multiple lines. It causes the text from#to the end of the line, denoted by\n, to be interpreted as a comment. For example:Prints "Hello World", rather than "Hello" as it does if
\nis removed or replaced by\r.This PR adds this behavior to the documentation.
Thanks for considering,
Kevin
Document Details
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.