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 - Microsoft.Extensions.Options #43919

Closed
Tracked by #43849
carlossanlop opened this issue Oct 27, 2020 · 1 comment · Fixed by dotnet/dotnet-api-docs#8514
Closed
Tracked by #43849

API documentation debt - Microsoft.Extensions.Options #43919

carlossanlop opened this issue Oct 27, 2020 · 1 comment · Fixed by dotnet/dotnet-api-docs#8514
Labels
area-Extensions-Options 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: @maryamariyan @ViktorHofer

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.

Microsoft.Extensions.Options
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Options namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Options.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options?branch=master
M:Microsoft.Extensions.Options.IOptionsFactory`1.Create(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/IOptionsFactory\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.IOptionsFactory-1.Create?branch=master
M:Microsoft.Extensions.Options.IOptionsMonitor`1.Get(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/IOptionsMonitor\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.IOptionsMonitor-1.Get?branch=master
M:Microsoft.Extensions.Options.IOptionsSnapshot`1.Get(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/IOptionsSnapshot\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.IOptionsSnapshot-1.Get?branch=master
M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0}) Present Present NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsBuilder\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsBuilder-1.PostConfigure?branch=master
M:Microsoft.Extensions.Options.OptionsFactory`1.Create(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsFactory\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsFactory-1.Create?branch=master
M:Microsoft.Extensions.Options.OptionsFactory`1.CreateInstance(System.String) Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsFactory\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsFactory-1.CreateInstance?branch=master
M:Microsoft.Extensions.Options.OptionsManager`1.Get(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsManager\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsManager-1.Get?branch=master
M:Microsoft.Extensions.Options.OptionsMonitor`1.Get(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsMonitor\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsMonitor-1.Get?branch=master
M:Microsoft.Extensions.Options.OptionsMonitorExtensions.OnChange``1(
Microsoft.Extensions.Options.IOptionsMonitor{``0},System.Action{``0})
Present Present Missing Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsMonitorExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsMonitorExtensions.OnChange?branch=master
M:Microsoft.Extensions.Options.OptionsWrapper`1.Add(System.String,`0) Present Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsWrapper\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsWrapper-1.Add?branch=master
M:Microsoft.Extensions.Options.OptionsWrapper`1.Remove(System.String) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsWrapper\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsWrapper-1.Remove?branch=master
T:Microsoft.Extensions.Options.IConfigureNamedOptions`1 Present NA Missing NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/IConfigureNamedOptions\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.IConfigureNamedOptions-1?branch=master
T:Microsoft.Extensions.Options.IConfigureOptions`1 Present NA Missing NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/IConfigureOptions\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.IConfigureOptions-1?branch=master
M:Microsoft.Extensions.Options.OptionsCache`1.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsCache\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsCache-1.-ctor?branch=master
M:Microsoft.Extensions.Options.ValidateOptionsResult.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/ValidateOptionsResult.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.ValidateOptionsResult.-ctor?branch=master
T:Microsoft.Extensions.Options.ConfigurationChangeTokenSource`1 Present NA Missing NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/ConfigurationChangeTokenSource\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.ConfigurationChangeTokenSource-1?branch=master
T:Microsoft.Extensions.Options.OptionsSnapshot`1 Present NA Missing NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Options/OptionsSnapshot\`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Options.OptionsSnapshot-1?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs are obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner area-Microsoft.Extensions labels Oct 27, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 27, 2020
@maryamariyan maryamariyan added area-Extensions-Options and removed area-Microsoft.Extensions untriaged New issue has not been triaged by the area owner labels Nov 5, 2020
@ghost
Copy link

ghost commented Nov 5, 2020

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Extensions-Options documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants