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

Ported System.Collections source code comments to Docs #2306

Merged
merged 4 commits into from Apr 26, 2019

Conversation

Projects
None yet
4 participants
@carlossanlop
Copy link
Member

commented Apr 15, 2019

Summary

Automatically ported all source code triple slash comments from System.Collections that are showing up as undocumented in MS Docs.

Fixes #Issue_Number (if available)

@carlossanlop

This comment has been minimized.

Copy link
Member Author

commented Apr 15, 2019

@mairaw Please take a look whenever you get a chance.
Adding the owner @safern in case he has any comments. I ported the comments with minimal changes: I made sure to make reserved words and element names to their correct langword/cref.

@rpetrusha
Copy link
Contributor

left a comment

Thanks for documenting the undocumented members and adding exception information, @carlossanlop. I've suggested a number of changes.

Show resolved Hide resolved xml/System.Collections.Immutable/IImmutableQueue`1.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/IImmutableQueue`1.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/IImmutableStack`1.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/IImmutableStack`1.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableArray.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableStack.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableStack`1.xml Outdated
Show resolved Hide resolved xml/System.Collections.Immutable/ImmutableStack`1.xml Outdated

@mairaw mairaw added this to the April 2019 milestone Apr 17, 2019

Apply suggestions from code review
Applying suggestions provided by rpetrusha.

Co-Authored-By: carlossanlop <1175054+carlossanlop@users.noreply.github.com>
@safern

safern approved these changes Apr 25, 2019

Copy link
Member

left a comment

LGTM but I'd like @rpetrusha or @mairaw to signoff

rpetrusha added some commits Apr 25, 2019

@rpetrusha rpetrusha merged commit 1534f9a into dotnet:master Apr 26, 2019

6 checks passed

OpenPublishing.Build Validation status: passed
Details
OpenPublishing.Build (1 of 3) Waiting for processor completed at 14:27:10 PST
OpenPublishing.Build (2 of 3) Preparing completed at 14:42:02 PST
OpenPublishing.Build (3 of 3) Building completed at 15:22:25 PST
WIP Ready for review
Details
license/cla All CLA requirements met.
Details

@carlossanlop carlossanlop deleted the carlossanlop:collections branch Apr 26, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.