-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Initial docs for StringRuneEnumerator and SpanRuneEnumerator #2821
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
Conversation
carlossanlop
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your PR. I left some comments for you to consider.
mairaw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good @GrabYourPitchforks! Left a few comments
Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com>
Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com>
Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
|
Apologies for the noise - going through and applying suggestions, which will introduce a bunch of tiny commits to the PR. |
Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> Co-Authored-By: Maira Wenzel <mairaw@microsoft.com>
|
If you go to the Files changed tab, you can batch them in a single commit @GrabYourPitchforks 😉 |
mairaw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I've added the boilerplate remarks that we add for EIIs as well (I've recently added to the wiki published at https://github.com/dotnet/dotnet-api-docs/wiki/Remarks#explicit-interface-implementation)
|
@mairaw the build passed, so I think this is good to merge. |
|
@rpetrusha this one's good to merge, the build passed. |
Summary
Adds documentation for
StringRuneEnumeratorandSpanRuneEnumerator, which are enumerators returned by theString.EnumerateRunesandMemoryExtensions.EnumerateRunesmethods. Developers should not use the enumerator types directly and should instead use syntax like the below:The proposed text for the documentation is based somewhat on the existing text for the
Span<T>+Enumeratortype./cc @mairaw @rpetrusha @carlossanlop