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

Fix XML triple slash docs per docs team suggestions #4194

Closed
AdamYoblick opened this issue Nov 4, 2020 · 4 comments
Closed

Fix XML triple slash docs per docs team suggestions #4194

AdamYoblick opened this issue Nov 4, 2020 · 4 comments
Labels
Priority:3 Work that is nice to have

Comments

@AdamYoblick
Copy link
Member

AdamYoblick commented Nov 4, 2020

See feedback in dotnet/dotnet-api-docs#5078 for suggestions.

  1. Make the fixes in winforms source
  2. Get those changes merged into main
  3. Regenerate the XML docs and PR them into the dotnet-api-docs repo
@Tanya-Solyanik
Copy link
Member

@LeafShi1 @SimonZhao888 @Epica3055 - please review the triple slash comments for instances of empty tags or placeholder strings, for example TBD or To be documented and fill them in or delete as appropriate. Note that for overridden methods doc-comments come from the base class and are not needed unless they mention a behavior change.

@Tanya-Solyanik Tanya-Solyanik added the Priority:3 Work that is nice to have label Jul 31, 2023
@Tanya-Solyanik
Copy link
Member

@LeafShi1 @SimonZhao888 @Epica3055 - please review the triple slash comments for instances of empty tags or placeholder strings, for example TBD or To be documented and fill them in or delete as appropriate. Note that for overridden methods doc-comments come from the base class and are not needed unless they mention a behavior change.

@LeafShi1
Copy link
Member

LeafShi1 commented Aug 1, 2023

@LeafShi1 @SimonZhao888 @Epica3055 - please review the triple slash comments for instances of empty tags or placeholder strings, for example TBD or To be documented and fill them in or delete as appropriate. Note that for overridden methods doc-comments come from the base class and are not needed unless they mention a behavior change.

I didn't find TBD or To be documented characters in the Winform repo, but only found one triple slash comments containing ToDo, do you mean we need to make changes to these.
image

@Tanya-Solyanik
Copy link
Member

No, todo is ok. Thank you for the investigation, I'll close this issue

@ghost ghost removed this from the Future milestone Aug 1, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Sep 1, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Priority:3 Work that is nice to have
Projects
None yet
Development

No branches or pull requests

3 participants