[release/8.0] Move comments on generated password entropy to public API (#3729) #3781
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
* Move comments on generated password entropy to public API This allows for these comments to be seen by callers of the API so they can make educated decisions on what parameters should be set for the password generation. Contributes to dotnet#237 * Format the remarks section.
dotnet-issue-labeler
bot
added
the
area-app-model
dotnet-policy-service
bot
added
the
Servicing-consider
sebastienros
approved these changes
Apr 17, 2024
mitchdenny
approved these changes
Apr 18, 2024
danmoseley
approved these changes
Apr 18, 2024
danmoseley
added
Servicing-approved
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.
Backport of #3729 to release/8.0
Customer Impact
A work item that came from our security review was to document our generated password entropy guarantees. This moves these comments to XML doc comments on public APIs so consumers can understand these guarantees.
Testing
N/A
Risk
Extremely Low. Only changing XML doc comments.
Regression?
No
This allows for these comments to be seen by callers of the API so they can make educated decisions on what parameters should be set for the password generation.
Contributes to #237
Microsoft Reviewers: Open in CodeFlow