Document System.String #2818
Merged
Document System.String #2818
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
carlossanlop
added
new-content
carlossanlop
requested review from
GrabYourPitchforks,
stephentoub,
tarekgh,
rpetrusha and
mairaw
tarekgh
approved these changes
Jul 24, 2019
rpetrusha
approved these changes
Jul 24, 2019
There was a problem hiding this comment.
This looks good, @carlossanlop, except for one suggestion. I'll approve now and merge once you've made the change and the build has finished.
rpetrusha
removed
the
waiting-on-reviews
|
There's also a merge conflict, @carlossanlop. |
|
@rpetrusha I applied your suggestion and resolved the merge conflict. Turns out the GetPinnableReference method had already been documented. I kept my update with an additional remark. |
carlossanlop
added
the
changes-addressed
mairaw
removed
the
changes-addressed
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 are the APIs introduced in 3.0 only. There are many more APIs that are not yet documented, we will leave them for later.
There is no explicit owner. The last people to modify the String code files in coreclr were: @GrabYourPitchforks @stephentoub @tarekgh . Can you please review the comments I added?
I based the
GetPinnableReferencedocumentation on this one: https://docs.microsoft.com/en-us/dotnet/api/system.span-1.getpinnablereference?view=netcore-3.0#System_Span_1_GetPinnableReferenceSome of the APIs didn't have triple slash comments, but they did have double slash comments: https://github.com/dotnet/coreclr/blob/f537a7aa452cbebed6a6e5a23a79144619c12095/src/System.Private.CoreLib/shared/System/String.cs
The API
EnumerateRuneshad triple slash comments and was automatically ported in this PR: https://github.com/dotnet/dotnet-api-docs/pull/2729/files