SignedXml: drop .NET 12 InvalidOperationException documentation - #13054
Open
krwq wants to merge 1 commit into
Open
SignedXml: drop .NET 12 InvalidOperationException documentation#13054krwq wants to merge 1 commit into
krwq wants to merge 1 commit into
Conversation
The dotnet/runtime PR that would have thrown InvalidOperationException on SignedXml instance reuse in .NET 12 (dotnet/runtime#132836) has been closed and is not going to ship. Remove the 10 <exception cref="T:System.InvalidOperationException"> entries added across ComputeSignature, CheckSignature, CheckSignatureReturningKey, LoadXml, AddReference, and AddObject, and drop the .NET 12-specific sentence from the `Instances are single-use` remarks section. The general guidance that a SignedXml instance is not intended to be reused across multiple signing or verification operations remains correct and stays.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes consistently remove now-inaccurate version-specific exception documentation without introducing formatting or content inconsistencies in the remaining guidance.
Pull request overview
This PR updates the API reference documentation for System.Security.Cryptography.Xml.SignedXml to remove .NET 12-specific guidance about throwing InvalidOperationException on instance reuse, since the corresponding runtime change will not ship. It keeps the general (version-agnostic) guidance that SignedXml instances are intended to be single-use per signing/verification operation.
Changes:
- Removed the
.NET 12-specific sentence describingInvalidOperationExceptionbehavior forSignedXmlinstance reuse. - Removed multiple
<exception cref="T:System.InvalidOperationException">entries that were tied to the canceled .NET 12 behavior. - Retained and simplified the “Instances are single-use” guidance to focus on correctness rather than a version-specific exception.
File summaries
| File | Description |
|---|---|
| xml/System.Security.Cryptography.Xml/SignedXml.xml | Removes .NET 12-specific InvalidOperationException documentation while keeping general single-use guidance for SignedXml. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
The dotnet/runtime PR that would have thrown
InvalidOperationExceptiononSignedXmlinstance reuse in .NET 12 (dotnet/runtime#132836) has been closed and is not going to ship.This PR removes the .NET 12-specific documentation added in #13042:
<exception cref="T:System.InvalidOperationException">entries acrossComputeSignature,CheckSignature,CheckSignatureReturningKey,LoadXml,AddReference, andAddObject.InvalidOperationException" sentence in theInstances are single-useremarks section.The general guidance that a
SignedXmlinstance is not intended to be reused across multiple signing or verification operations remains correct on all supported .NET versions and stays.Companion cleanup PR in
dotnet/docsfor the how-to callouts.Internal previews
Build report