Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic port of RegexParse* documentation #4850

Merged
merged 6 commits into from
Sep 16, 2020

Conversation

carlossanlop
Copy link
Member

Freshly introduced. Porting to the RC2 branch.

@opbld30
Copy link

opbld30 commented Sep 15, 2020

Docs Build status updates of commit c7eab1f:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.RegularExpressions/RegexParseError.xml ✅Succeeded View
xml/System.Text.RegularExpressions/RegexParseException.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@@ -34,7 +42,8 @@
</ReturnValue>
<MemberValue>17</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation construct in a regular expression contains a comment.</summary>
<remarks>To be added.</remarks>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are all the <remarks> set to To be added.?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe To be added is the default for remarks. IIRC remarks don't show up in Intellisense.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about docs.microsoft.com?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked @carlossanlop exactly that question a while back. Waiting for an answer :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If "To be added" is found, then nothing is shown. It's the default empty string for MS Docs.

The reason why it was added is because the DocsPortingTool expects the xml element to exist. I could get it fixed, so that if it's not found, I won't add it unless there's something to port.

Suggested change
<remarks>To be added.</remarks>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eerhardt @pgovind I removed them.

Copy link

@pgovind pgovind left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@opbld30
Copy link

opbld30 commented Sep 15, 2020

Docs Build status updates of commit 966a464:

🕙 Pending: waiting for processors (5 builds ahead of you)

⚠️ Docs Build is busy, currently there are 5 builds ahead of this one, for more information you can view the Build queue graph on the Docs Portal.

xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
xml/System.Text.RegularExpressions/RegexParseError.xml Outdated Show resolved Hide resolved
@opbld33
Copy link

opbld33 commented Sep 15, 2020

Docs Build status updates of commit 966a464:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.RegularExpressions/RegexParseError.xml ✅Succeeded View
xml/System.Text.RegularExpressions/RegexParseException.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld30
Copy link

opbld30 commented Sep 15, 2020

Docs Build status updates of commit b5e83bc:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.RegularExpressions/RegexParseError.xml ✅Succeeded View
xml/System.Text.RegularExpressions/RegexParseException.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld34
Copy link

opbld34 commented Sep 15, 2020

Docs Build status updates of commit e71cd07:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.RegularExpressions/RegexParseError.xml ✅Succeeded View
xml/System.Text.RegularExpressions/RegexParseException.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld30
Copy link

opbld30 commented Sep 15, 2020

Docs Build status updates of commit 6bd16d4:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Text.RegularExpressions/RegexParseError.xml ✅Succeeded View
xml/System.Text.RegularExpressions/RegexParseException.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@carlossanlop carlossanlop merged commit ee2fa90 into dotnet:net5-rc2 Sep 16, 2020
gewarren pushed a commit to gewarren/dotnet-api-docs that referenced this pull request Sep 24, 2020
* Automatic port of RegexParse* documentation

* Update xml/System.Text.RegularExpressions/RegexParseError.xml

* Apply suggestions from code review

* Update RegexParseException

* Update xml/System.Text.RegularExpressions/RegexParseException.xml

* Update xml/System.Text.RegularExpressions/RegexParseException.xml

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>
carlossanlop added a commit that referenced this pull request Sep 24, 2020
* Automatic port of System.OperatingSystem docs for RC2 (#4852)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Add Missing System.Diagnostics docs (#4856)

* Add Missing System.Diagnostics docs

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Automatically port System.Diagnostics docs for RC2 (#4853)

* Automatically port System.Diagnostics docs for RC2

* Update xml/System.Diagnostics/ActivitySamplingResult.xml

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Update xml/System.Diagnostics/Process.xml

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>

* Automatic port of RegexParse* documentation (#4850)

* Automatic port of RegexParse* documentation

* Update xml/System.Text.RegularExpressions/RegexParseError.xml

* Apply suggestions from code review

* Update RegexParseException

* Update xml/System.Text.RegularExpressions/RegexParseException.xml

* Update xml/System.Text.RegularExpressions/RegexParseException.xml

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>

* Add ssl API added between preview 7 and 8 (#4860)

* Automatic port of Reflection RC2 documentation (#4851)

* Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868)

This reverts commit 10d2b88.

* Add ssl API added between preview 7 and 8 #2 (#4869)

* Add ssl API added between preview 7 and 8

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Update xml/System.Net.Security/SslStream.xml

* Apply @wfurt comments

* Add missing remark headers

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback (#4861)

* Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback

* Apply PR comments

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Add a remark to AddEvent method (#4871)

* Add a remark to AddEvent method

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Automatic port of CryptoStream docs (#4888)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Automatic port of System.Buffers docs (#4882)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* resolve isprefix conflict

* Automatic port of System.Data.Common docs (#4885)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Automatic port of *PipeServerStreamAcl docs (#4880)

* Automatic port of *PipeServerStreamAcl docs

* Apply suggestions from code review

Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>

* Apply suggestions from code review

Co-authored-by: David Cantú <dacantu@microsoft.com>

* Apply suggestions from code review

* Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml

* Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>

* Automatic port of *OSPlatformAttribute docs (#4883)

* Automatic port of *OSPlatformAttribute docs

* Missing TargetPlatformAttribute constructor parameter description.

* Apply suggestions from code review

Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com>

* Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com>

* Document System.Enum (#4894)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Document Half.op_Explicit APIs (#4893)

* Document Half.op_Explicit APIs

* Equals

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Automatic port of Rune.CompareTo EII (#4891)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Add missing docs for AsnContentException. (#4895)

* Add missing documentation for S.S.Cryptography (#4892)

* Add missing documentation for S.S.Cryptography

* Apply feedback

* Automatic port of System.Threading.ExecutionContext.Restore doc (#4887)

* Automatic port of System.Threading.ExecutionContext.Restore doc

* Update xml/System.Threading/ExecutionContext.xml

Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>

* Apply suggestions from code review

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>

* Automatic port of  explicit interface implementation of System.Net.Http.HttpRequestOptions (#4881)

* Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions

* Apply suggestions from code review

Co-authored-by: Jan Jahoda <aik.jahoda@post.cz>

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Jan Jahoda <aik.jahoda@post.cz>

* Document Type.IsAssignableTo (#4898)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* Document System.PlatformID.Other (#4897)

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>

* HTTP Version Selection (#4870)

* Sync docs with source comments

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Add values

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* HttpClient sync operations (#4776)

* Draft for @ManickaP

* Apply suggestions from code review

Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com>

* Format verification

* Format verification

* Fix links

* Fix links

* Fix xml tag

* Fix links

* Fix links

* Fix links

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Fix links

* Add CreateContentReadStream

* Fix links

* Add System.Net.Http.DelegatingHandler.Send

* Fix links

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Remove "Synchronous" information from summary

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Fix the  exception description

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com>
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* adding docs for missing 5.0 apis for system.Runtime.CompilerServices.Unsafe  (#4902)

* adding docs for missing 5.0 apis

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* resolve conflict

* Add Sysytem.Net.* missing API (#4904)

* System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections

* Add Sysytem.Net.\* missing API

* Apply PR comments

* Apply suggestions from code review

* Apply suggestions from code review

* Update xml/System.Net.Http/SocketsHttpHandler.xml

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

* Http sync follow up (#4905)

* Add the http sync follow up

* Fix closing tag

Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>

Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com>
Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>
Co-authored-by: Jan Jahoda <jajahoda@microsoft.com>
Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: David Cantú <dacantu@microsoft.com>
Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com>
Co-authored-by: Jeremy Barton <jbarton@microsoft.com>
Co-authored-by: Jan Jahoda <aik.jahoda@post.cz>
Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com>
Co-authored-by: Anirudh Agnihotry <anirudhagnihotry098@gmail.com>
@carlossanlop carlossanlop deleted the RegexParse branch August 6, 2024 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants