Port System.Reflection source comments to Docs #2317
Merged
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
|
@mairaw @rpetrusha Please take a look whenever you get a chance. Adding the area owners @steveharter, @GrabYourPitchforks in case they have additional comments or corrections. |
rpetrusha
suggested changes
Apr 17, 2019
There was a problem hiding this comment.
Thanks for documenting these two types, @carlossanlop. The import procedure didn't import the triple-slash comments applied to the two types; I've added them. I've also suggested a number of changes.
Applying suggestions by rpetrusha in PR. Co-Authored-By: carlossanlop <[email protected]>
rpetrusha
approved these changes
Apr 25, 2019
|
Thanks for making the additional changes, @carlossanlop. I've corrected some broken links and moved part of the Dispose description to the Remarks section. I'll merge when the build completes successfully. |
|
Thank you @rpetrusha for fixing the links and Dispose. |
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
Automatically ported source code triple slash comments found in System.Reflection that were missing in dotnet-api-docs.
I made sure to format some of the text to avoid cramming everything to the summaries. There were also some exceptions described in the summaries that should be actual exception elements, so I added them.
Fixes #Issue_Number (if available)