Draft
Backport missed remarks on Regex constructors#131248
Conversation
|
Azure Pipelines: 16 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
…ex constructors - Replace <remarks><format type="text/markdown"><![CDATA[...]]></format></remarks> blocks on the three public Regex constructors with standard XML doc comments using <para>, <list>, <see cref>, <see href>, <paramref>, and <c> elements. - Add <example><code lang="cs" source="..." region="..." /></example> blocks after <remarks>, referencing the examples file by region name. - Add constructor example code to Regex.Examples.cs with #region blocks matching region names: RegexCtorString, RegexCtorStringOptions, and RegexCtorStringOptionsMatchTimeout. Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update XML documentation for Regex public constructors
Replace CDATA/Markdown XML doc remarks on Regex constructors with standard XML docs
Jul 23, 2026
Contributor
|
Replaces #131168. |
gewarren
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (2)
src/libraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/Regex.cs:123
- Same as above:
<code>should useregion(matching the#region RegexCtorStringOptionsblock in the examples file) rather thanid, so the snippet can be extracted/rendered correctly.
/// <example>
/// The following example uses this constructor to create a case-insensitive regular expression that matches words beginning with the letters "a" or "t".
/// <code lang="cs" source="../../../../tests/FunctionalTests/Regex.Examples.cs" id="RegexCtorStringOptions" />
/// </example>
src/libraries/System.Text.RegularExpressions/src/System/Text/RegularExpressions/Regex.cs:174
- Same as above:
<code>should useregion(matching the#region RegexCtorStringOptionsMatchTimeoutblock) rather thanid, otherwise the snippet selector likely won't work.
/// <example>
/// The following example creates a <see cref="Regex"/> object with a very short initial time-out and retries with a larger one if a timeout occurs.
/// <code lang="cs" source="../../../../tests/FunctionalTests/Regex.Examples.cs" id="RegexCtorStringOptionsMatchTimeout" />
/// </example>
Comment on lines
+96
to
+99
| /// <example> | ||
| /// The following example uses this constructor to create a regular expression that matches words beginning with the letters "a" or "t". | ||
| /// <code lang="cs" source="../../../../tests/FunctionalTests/Regex.Examples.cs" id="RegexCtorString" /> | ||
| /// </example> |
gewarren
reviewed
Jul 23, 2026
| /// </remarks> | ||
| /// <example> | ||
| /// The following example uses this constructor to create a regular expression that matches words beginning with the letters "a" or "t". | ||
| /// <code lang="cs" source="../../../../tests/FunctionalTests/Regex.Examples.cs" id="RegexCtorString" /> |
Contributor
There was a problem hiding this comment.
I'm not sure if we can use IDs/regions of code using <code> elements. See https://www.mono-project.com/docs/tools+libraries/tools/monodoc/editing/.
Contributor
There was a problem hiding this comment.
Also separate source files in <code> elements are silently ignored for Learn docs generation: https://dev.azure.com/ceapex/Engineering/_workitems/edit/1163255
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-text-regularexpressions |
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
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.
These remarks and examples were missed in #127038.
Converts the CDATA/Markdown
<remarks>blocks added to the three publicRegexconstructors into standard XML doc comments that render correctly in IntelliSense.Regex.cs— For each ofRegex(string),Regex(string, RegexOptions), andRegex(string, RegexOptions, TimeSpan):<remarks><format type="text/markdown"><![CDATA[...]]></format></remarks>with standard<remarks>using<para>,<list>,<see cref>,<see href>,<paramref>, and<c><remarks>into<example><code lang="cs" source="..." region="..." /></example>blocks placed after<remarks>and before<exception>, referencing regions in the examples fileRegex.Examples.cs— AddedRegexConstructorExamplesclass with three[Fact]methods covering the constructor overloads, each wrapped in a named#regionblock (RegexCtorString,RegexCtorStringOptions,RegexCtorStringOptionsMatchTimeout).Fixes dotnet/dotnet-api-docs#12869.