Improve summaries for methods in AzureAppConfigurationOptions #467
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
jimmyca15
reviewed
Sep 28, 2023
| @@ -118,6 +118,7 @@ internal IEnumerable<IKeyValueAdapter> Adapters | |||
| /// <summary> | |||
| /// Specify what key-values to include in the configuration provider. | |||
| /// <see cref="Select"/> can be called multiple times to include multiple sets of key-values. | |||
| /// If neither <see cref="Select"/> nor <see cref="SelectSnapshot"/> is ever called, all key-values with null label are included in the configuration provider. | |||
There was a problem hiding this comment.
The intent seems good, but it's a bit odd that it's on the Select method. I guess I would expect it on AppConfigurationOptions summary.
There was a problem hiding this comment.
Yea I agree honestly, I wasn't sure if adding it to the options summary seemed random/too much information there. Probably a bit better than this
jimmyca15
reviewed
Oct 5, 2023
src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationOptions.cs
Outdated
Show resolved
Hide resolved
jimmyca15
approved these changes
Oct 5, 2023
Co-authored-by: Jimmy Campbell <jimmyca@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add mention of default query in the summary for
AzureAppConfigurationOptions. Fix tags in summary forAzureAppConfigurationOptions.UseFeatureFlags.