Rc2 doc comments #4908
Merged
Rc2 doc comments #4908
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
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
* 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 * 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 * 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 * 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>
…otnet#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 * 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>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
* 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 * 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>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
* Document Half.op_Explicit APIs * Equals Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
* Add missing documentation for S.S.Cryptography * Apply feedback
…et#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>
…p.HttpRequestOptions (dotnet#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>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com>
* 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>
* 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>
…Unsafe (dotnet#4902) * adding docs for missing 5.0 apis * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
* 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>
* Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com>
gewarren
reviewed
Sep 24, 2020
| @@ -3097,14 +3107,24 @@ Use <xref:System.Globalization.CompareInfo.GetSortKeyLength(System.ReadOnlySpan{ | |||
| <Parameter Name="matchLength" Type="System.Int32" RefType="out" Index="3" FrameworkAlternate="net-5.0" /> | |||
| </Parameters> | |||
| <Docs> | |||
| <param name="source">To be added.</param> | |||
| <param name="suffix">To be added.</param> | |||
There was a problem hiding this comment.
Here's the weird line where the latest CI job showed a suffix parameter.
There was a problem hiding this comment.
@joelmartinez We're a bit confused why mdoc didn't realize the suffix parameter was renamed to prefix, and instead just added prefix as an additional parameter. The deletion of suffix here is something I did manually. The method was added in .NET 5 RC1 and the parameter name changed in .NET 5 RC2.
There was a problem hiding this comment.
@gewarren mdoc will remake the Parameter elements because those come directly from the metadata so it remakes them every time ... but in general it's a bit more tentative with removing elements in the Docs node, because those can contain user-written content, so in cases like this it's best just to adjust manually as you've done here
There was a problem hiding this comment.
Would that even have shown up in the rendered page if I hadn't removed it?
There was a problem hiding this comment.
@gewarren no I believe it wouldn't, because the rendering is driven by the Parameter entries ... it also shouldn't affect the intellisense, because it would just kind of be ignored, so even if we leave it it wouldn't be world-ending :)
gewarren
approved these changes
Sep 24, 2020
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.
Summary
Describe your changes here.
Fixes #Issue_Number (if available)