Skip to content

Clarify async validation source documentation from API docs review - #135691

Merged
ViveliDuCh merged 2 commits into
mainfrom
async-validation-review-feedback
Oct 14, 2026
Merged

ViveliDuCh merged 2 commits into
mainfrom
async-validation-review-feedback

Conversation

@ViveliDuCh

@ViveliDuCh ViveliDuCh commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Document propagated OperationCanceledException on all eight asynchronous Validator overloads and AsyncValidationAttribute.GetValidationResultAsync.
  • Use present-tense wording, describe cancellation during asynchronous enumeration, and clarify the optional validation-results collections and value-validation return contract.
  • Explain required-property validation on both ValidateObjectAsync overloads, including the nonrecursive scope of validateAllProperties.
  • Replace vague shorter-constructor guidance with links to the attribute/value-preserving ValidationException overload, while preserving the distinction from the inner-exception overload.

These changes affect only XML comments in four source files. They preserve the previously addressed review feedback and do not change executable code, API signatures, reference assemblies, or documentation ownership settings. Existing Options guidance already addresses the applicable feedback and is unchanged.

System.ComponentModel.Annotations reference documentation is maintained in dotnet/dotnet-api-docs on dotnet/dotnet-api-docs#13101. These source-alignment changes do not replace the matching direct ECMAXML updates there.

Validation

  • Built src\libraries\System.ComponentModel.Annotations\src\System.ComponentModel.Annotations.csproj successfully with zero warnings and zero errors.
  • Verified XML-comment syntax, all nine cancellation exception entries, and all three compiler-resolved constructor references.
  • Verified that executable source is unchanged and git diff --check passes.
  • No tests run: documentation-only changes.

Note

This PR description and the source documentation updates were prepared with GitHub Copilot.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 34759cec-00a3-4d2e-b5c2-05b2e882b21c
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 3 pipeline(s).
13 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/area-system-componentmodel-dataannotations
See info in area-owners.md if you want to be subscribed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 0e4f9f74-7009-4e9f-8a00-4abfafca6592
@ViveliDuCh
ViveliDuCh merged commit 7cf2e44 into main Oct 14, 2026
86 of 88 checks passed
@ViveliDuCh
ViveliDuCh deleted the async-validation-review-feedback branch October 14, 2026 08:25
@ViveliDuCh

Copy link
Copy Markdown
Member Author

/backport to release/11.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/11.0 (link to workflow run)

ViveliDuCh added a commit that referenced this pull request Oct 14, 2026
… docs review (#135750)

Backport of #135691 to release/11.0

/cc @ViveliDuCh

Clarifies guidance for the public `IValidatableObject` validation entry
points and improves wording following API-reference review feedback.

## Customer Impact

- [ ] Customer reported
- [x] Found internally

Adds API documentation guidance for the new .NET 11 asynchronous
validation feature.

## Regression

- [ ] Yes
- [x] No

Documentation update for a new feature.

## Testing

Documentation-only change. Reviewed the backport diff; all changes are
XML documentation comments. No build or tests run for this backport.

## Risk

Low; API documentation only, with no runtime behavior or API shape
changes.

Co-authored-by: Viviana Dueñas <50237907+ViveliDuCh@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 34759cec-00a3-4d2e-b5c2-05b2e882b21c
Copilot-Session: 0e4f9f74-7009-4e9f-8a00-4abfafca6592
@dotnet-milestone-bot dotnet-milestone-bot Bot added this to the 12.0-preview1 milestone Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants