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

API documentation debt - System.Diagnostics #43860

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

API documentation debt - System.Diagnostics #43860

carlossanlop opened this issue Oct 26, 2020 · 5 comments
Assignees
Labels
area-System.Diagnostics documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

Area owners: @noahfalk @tommcdon @tarekgh @Anipik @krwq

The APIs in the list below are missing some or all of their documentation. I noticed these APIs are part of Platform Extensions, and were not added to the dotnet-plat-ext-5.0 moniker. I am not sure if this means they are obsolete, so if they are unsupported, please let me know if you decide not to document them.

If you do decide to document them, feel free to document them in triple slash directly and we will make sure they get ported. If it's easier to get them documented in dotnet-api-docs, that is ok too.

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.Diagnostics.DiagnosticListenerExtensions
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
T:System.Diagnostics.DiagnosticListenerExtensions Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Diagnostics/DiagnosticListenerExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.Diagnostics.DiagnosticListenerExtensions?branch=master
M:System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter(System.Diagnostics.DiagnosticListener,System.Object) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Diagnostics/DiagnosticListenerExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter?branch=master
M:System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter(System.Diagnostics.DiagnosticListener,System.Object,System.Func{System.String,System.Boolean}) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Diagnostics/DiagnosticListenerExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter?branch=master
M:System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter(System.Diagnostics.DiagnosticListener,System.Object,System.Func{System.String,System.Object,System.Object,System.Boolean}) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Diagnostics/DiagnosticListenerExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/System.Diagnostics.DiagnosticListenerExtensions.SubscribeWithAdapter?branch=master
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code area-System.Diagnostics help wanted [up-for-grabs] Good issue for external contributors labels 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
@ghost
Copy link

ghost commented Oct 26, 2020

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

@Dotnet-GitSync-Bot Dotnet-GitSync-Bot added the untriaged New issue has not been triaged by the area owner label Oct 26, 2020
@tommcdon tommcdon removed the untriaged New issue has not been triaged by the area owner label Oct 27, 2020
@tommcdon tommcdon added this to On Deck in .NET Core Diagnostics Oct 27, 2020
@hoyosjs hoyosjs moved this from On Deck to 6.0.0 in .NET Core Diagnostics Jul 21, 2021
@noahfalk noahfalk self-assigned this Jul 28, 2021
@noahfalk
Copy link
Member

@tarekgh @ericstj - do either of you recognize Microsoft.Extensions.DiagnosticAdapter assembly? According to the docs links that is the assembly which contains these APIs but I didn't find this type in our repo.

@tarekgh
Copy link
Member

tarekgh commented Jul 28, 2021

@ericstj @Anipik @maryamariyan may know better about this one. I am seeing originally the code was in the extensions repo https://github.com/dotnet/extensions/blob/release/2.1/src/DiagnosticAdapter/src/DiagnosticListenerExtensions.cs but I don't from where we released the last version https://www.nuget.org/packages/Microsoft.Extensions.DiagnosticAdapter/5.0.0-preview.3.20215.2. Looks to me it is released as part of asp.net as the NuGet page indicate.

@ericstj
Copy link
Member

ericstj commented Jul 28, 2021

Per aspnet/Announcements#411 that component was dead-ended. The last place the code lived is here: https://github.com/dotnet/extensions/tree/release/3.1/src/DiagnosticAdapter

@noahfalk
Copy link
Member

Thanks all!

I am not sure if this means they are obsolete, so if they are unsupported, please let me know if you decide not to document them.

Based on info from @ericstj this assembly was last shipped in 3.1 and we've decided not to ship new releases. It is by design that there is no 5.0 version.

.NET Core Diagnostics automation moved this from 6.0.0 to Done Jul 29, 2021
API Documentation Debt automation moved this from To do to Done Jul 29, 2021
@ghost ghost moved this from Done to 6.0.0 in .NET Core Diagnostics Jul 29, 2021
@ghost ghost locked as resolved and limited conversation to collaborators Aug 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-System.Diagnostics documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Development

No branches or pull requests

7 participants