Skip to content

Remove opinions from Rfc2898DeriveBytes docs#12694

Merged
bartonjs merged 2 commits into
mainfrom
bartonjs/rfc2898docs
Jun 2, 2026
Merged

Remove opinions from Rfc2898DeriveBytes docs#12694
bartonjs merged 2 commits into
mainfrom
bartonjs/rfc2898docs

Conversation

@bartonjs
Copy link
Copy Markdown
Member

@bartonjs 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".

Copilot AI review requested due to automatic review settings June 1, 2026 23:55
@bartonjs bartonjs requested a review from a team as a code owner June 1, 2026 23:55
@github-actions github-actions Bot added the area-System.Security Issues related to security practices for .NET developers. label Jun 1, 2026
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-security, @vcsjones

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 IterationCount property’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”.

@bartonjs bartonjs enabled auto-merge (squash) June 2, 2026 00:34
@bartonjs bartonjs merged commit 45750f4 into main Jun 2, 2026
5 of 6 checks passed
@bartonjs bartonjs deleted the bartonjs/rfc2898docs branch June 2, 2026 00:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-System.Security Issues related to security practices for .NET developers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants