Port System.Diagnostics source code comments to Docs #2336
Conversation
|
@mairaw @rpetrusha please take a look. Adding area owners @wtgodbe, @krwq. Please take a look too, the comments had weird wording, I tried to fix as much as possible but I think it still would need some tweaking. |
Updated a multiline comment based on Will's suggestion.
Suggested changes by wtgodbe.
Removed newline.
Removed new lines.
Newlines and link to Write API.
rpetrusha suggestions Co-Authored-By: Ron Petrusha <ronpet@microsoft.com>
|
There are still some very long descriptions for some parameters and summaries. |
|
@mairaw @rpetrusha done! Sorry for the delay. The last suggestions were larger and required me to edit the files directly in my machine. |
|
@rpetrusha let me know if you have any additional comments. Otherwise, we may be able to get this merged. |
There was a problem hiding this comment.
Sorry, @carlossanlop; I neglected to review the documentation for the last type. I've done that here, and also submitted a commit that corrects some broken xrefs.
Suggestions by rpetrusha. Co-Authored-By: Ron Petrusha <ronpet@microsoft.com>
No worries, thank you for finding those broken xrefs. I also found one in a remark suggestion. Aside from that one, I commited all your suggestions right away. Once the build passes, I think we can merge this. |
|
@mairaw @rpetrusha I think this one's ready to merge. Maira's requested changes were addressed some time ago, but I'm not sure why the "Changes requested" state has the red icon saying that I have not addressed them. Can you please take a look? |
|
I was going to dismiss your review because you were on vacation once the build completed, @mairaw, but I completely forgot. Do you want to approve the PR now? |
|
Friendly ping @mairaw @rpetrusha |
|
Looking at this now. |
Summary
Automatically ported triple slash source code comments found in System.Diagnostics that did not exist in dotnet-api-docs.
Fixes #Issue_Number (if available)