Remove opinions from Rfc2898DeriveBytes docs#12694
Merged
Merged
Conversation
Member
bartonjs
commented
Jun 1, 2026
- Remove the "recommended minimum" from the API documentation. The correct answer is too complicated for API docs.
- In the sample that references the "default" value (which is from an Obsolete constructor) call it instead the "legacy default".
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the API reference documentation for System.Security.Cryptography.Rfc2898DeriveBytes to remove prescriptive guidance about iteration-count minimums and to clarify that the sample’s referenced constructor defaults are legacy behavior (from an obsolete constructor).
Changes:
- Removed “minimum recommended number of iterations is 1000” statements from multiple Remarks sections in
Rfc2898DeriveBytes.xml. - Removed the iteration-count recommendation from the
IterationCountproperty’s Remarks so the section is no longer opinionated. - Updated the C# snippet comment to describe the “legacy default” iteration count rather than calling it the “default”.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml | Removes iteration-count recommendation language from constructor and property documentation. |
| snippets/csharp/System.Security.Cryptography/Rfc2898DeriveBytes/Overview/rfc28981.cs | Updates sample commentary to refer to the obsolete-constructor behavior as a “legacy default”. |
gewarren
approved these changes
Jun 2, 2026
This file contains hidden or 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
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.