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.

Sign up for GitHub

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

Jump to bottom

API documentation debt - System.ComponentModel #43852

Closed
Tracked by #43849
carlossanlop opened this issue Oct 26, 2020 · 3 comments
Closed
Tracked by #43849

API documentation debt - System.ComponentModel #43852

carlossanlop opened this issue Oct 26, 2020 · 3 comments
Assignees
@buyaa-n
Labels
area-System.ComponentModel documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
API Documentation Debt
Milestone
8.0.0

Comments

@carlossanlop
Copy link
Member

carlossanlop commented Oct 26, 2020 •
edited

Area owners: @safern @ericstj

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

System.ComponentModel
DocId Summary Parameters TypeParameters ReturnValue
M:System.ComponentModel.BackgroundWorker.Dispose(System.Boolean) Missing Missing NA NA
@carlossanlop carlossanlop added the documentation Documentation bug or enhancement, does not impact product or test code label Oct 26, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 26, 2020
@carlossanlop carlossanlop added this to To do in API Documentation Debt via automation Oct 26, 2020
@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added area-System.ComponentModel untriaged New issue has not been triaged by the area owner labels Oct 26, 2020
@ghost
Copy link

ghost commented Oct 26, 2020

Tagging subscribers to this area: @safern
See info in area-owners.md if you want to be subscribed.

@carlossanlop carlossanlop added the help wanted [up-for-grabs] Good issue for external contributors label Oct 26, 2020
@carlossanlop carlossanlop mentioned this issue Oct 26, 2020
Open
23 tasks
@maryamariyan maryamariyan removed this from the 6.0.0 milestone Feb 3, 2021
@maryamariyan maryamariyan removed the untriaged New issue has not been triaged by the area owner label Feb 25, 2021
@maryamariyan maryamariyan added this to the 6.0.0 milestone Feb 25, 2021
@ghost ghost moved this from Untriaged to 6.0.0 in ML, Extensions, Globalization, etc, POD. Feb 25, 2021
@johnthcall johnthcall mentioned this issue May 8, 2021
Closed
@maryamariyan maryamariyan modified the milestones: 6.0.0, 7.0.0 Jul 22, 2021
@ghost ghost moved this from 6.0.0 to Untriaged in ML, Extensions, Globalization, etc, POD. Jul 22, 2021
@maryamariyan maryamariyan moved this from Untriaged to 7.0.0 in ML, Extensions, Globalization, etc, POD. Aug 4, 2021
@tarekgh tarekgh modified the milestones: 7.0.0, Future Aug 10, 2022
@ericstj
Copy link
Member

ericstj commented Nov 29, 2022

This looks like an easy fix. Just missing docs on a single API. cc @dotnet/area-system-componentmodel

@ericstj ericstj removed this from the Future milestone Nov 29, 2022
@ghost ghost added the untriaged New issue has not been triaged by the area owner label Nov 29, 2022
@ericstj ericstj added this to the 8.0.0 milestone Nov 29, 2022
@ghost ghost removed the untriaged New issue has not been triaged by the area owner label Nov 29, 2022
@buyaa-n buyaa-n self-assigned this Dec 12, 2022
@buyaa-n
Copy link
Member

buyaa-n commented Dec 14, 2022

I see the Summary and Parameters sections are documented already: https://github.com/dotnet/dotnet-api-docs/blob/e15fd6a32cae6a52fca00d71887ba3e9ad2b880d/xml/System.ComponentModel/BackgroundWorker.xml#L339-L340

@buyaa-n buyaa-n closed this as not planned Won't fix, can't repro, duplicate, stale Dec 14, 2022
API Documentation Debt automation moved this from To do to Done Dec 14, 2022
@ghost ghost locked as resolved and limited conversation to collaborators Jan 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@buyaa-n buyaa-n

Labels
area-System.ComponentModel documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
API Documentation Debt
  
Done
Milestone
8.0.0
Development

No branches or pull requests
6 participants
@carlossanlop @maryamariyan @ericstj @tarekgh @Dotnet-GitSync-Bot @buyaa-n