docs: add missing document to microsoft.extensions.options #76121
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
community-contribution
|
Tagging subscribers to this area: @dotnet/area-extensions-options Issue DetailsI couldn't find some of the apis, maybe they are no longer valid, or I missed something.
Contributes to #43919
|
|
@carlossanlop asked about reviewer but I don't have the permission. |
carlossanlop
requested review from
gewarren,
tarekgh,
eerhardt and
maryamariyan
src/libraries/Microsoft.Extensions.Options/src/IConfigureNamedOptions.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/IConfigureOptions.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/IOptionsChangeTokenSource.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/IOptionsFactory.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/IOptionsMonitor.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/OptionsFactory.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/OptionsManager.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/OptionsManager.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/OptionsMonitor.cs
Outdated
Show resolved
Hide resolved
src/libraries/Microsoft.Extensions.Options/src/OptionsMonitor.cs
Outdated
Show resolved
Hide resolved
tarekgh
reviewed
Sep 26, 2022
| /// <param name="name">The name of <typeparamref name="TOptions"/> instance to create.</param> | ||
| /// <returns>The created <typeparamref name="TOptions"/> instance with thw given <paramref name="name"/>.</returns> | ||
| /// <exception cref="OptionsValidationException">One or more <see cref="IValidateOptions{TOptions}"/> return failed <see cref="ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception> | ||
| /// <exception cref="MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception> |
There was a problem hiding this comment.
Just wondering, do we mention the exceptions in the interface docs? I think the exception is mainly thrown from the actual interface implementation. This comment applies to other places in this PR.
There was a problem hiding this comment.
That is a very good question, I don't think we should have exceptions here.
There was a problem hiding this comment.
Done, I removed the exceptions from interface docs.
|
@ikesnowy thanks for the PR. I added a little comment/question. Other than @carlossanlop comments, LGTM. |
Co-authored-by: Carlos Sanchez <[email protected]>
tarekgh
approved these changes
Sep 27, 2022
|
@carlossanlop if you are ok with the changes we can merge this one. |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I couldn't find some of the apis, maybe they are no longer valid, or I missed something.
M:Microsoft.Extensions.Options.OptionsWrapper`1.Add(System.String,`0)(No such method inOptionsWrapper)M:Microsoft.Extensions.Options.OptionsWrapper`1.Remove(System.String)(No such method inOptionsWrapper)M:Microsoft.Extensions.Options.OptionsCache`1.#ctor(OptionsCacheuses default constructor)M:Microsoft.Extensions.Options.ValidateOptionsResult.#ctor(ValidateOptionsResultuses default constructor)T:Microsoft.Extensions.Options.OptionsSnapshot(No such type)Contributes to #43919