Skip to content

Fix docs issues#67165

Merged
gewarren merged 1 commit into
dotnet:mainfrom
gewarren:docs-0626
Jun 11, 2026
Merged

Fix docs issues#67165
gewarren merged 1 commit into
dotnet:mainfrom
gewarren:docs-0626

Conversation

@gewarren

Copy link
Copy Markdown
Contributor
  • The references to DisplayNameInfo weren't resolving in docs, presumably because they are resolving to the internal property of the same name.
  • The references to DefaultValidationLocalizer fail because it's internal (and internal types aren't published on Learn).

See dotnet/dotnet-api-docs#12732.

Copilot AI review requested due to automatic review settings June 11, 2026 20:24
@github-actions github-actions Bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Jun 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 XML documentation in the Microsoft.Extensions.Validation area to avoid broken/unresolvable API doc links on Learn caused by <see cref="..."/> references pointing at internal members/types.

Changes:

  • Adjusts constructor <param> docs in Validatable*Info types to avoid <see cref="DisplayNameInfo"/> resolving to the internal DisplayNameInfo property.
  • Removes <see cref="DefaultValidationLocalizer"/> references from public extension method docs because the type is internal.
  • Tweaks phrasing in the localization extension docs to describe the default localizer without referencing the internal implementation type.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
src/Validation/src/ValidatableTypeInfo.cs Updates XML doc param text for displayNameInfo to avoid broken cref binding.
src/Validation/src/ValidatablePropertyInfo.cs Updates XML doc param text for displayNameInfo to avoid broken cref binding.
src/Validation/src/ValidatableParameterInfo.cs Updates XML doc param text for displayNameInfo to avoid broken cref binding.
src/Validation/Localization/src/ValidationLocalizationServiceCollectionExtensions.cs Removes internal-type cref references and rewords docs for the default localization wiring.

Comment thread src/Validation/src/ValidatableTypeInfo.cs
Comment thread src/Validation/src/ValidatablePropertyInfo.cs
Comment thread src/Validation/src/ValidatableParameterInfo.cs
@gewarren gewarren requested a review from oroztocil June 11, 2026 21:04
@gewarren gewarren enabled auto-merge (squash) June 11, 2026 21:04
@gewarren gewarren merged commit 7e5dc0c into dotnet:main Jun 11, 2026
27 checks passed
@gewarren gewarren deleted the docs-0626 branch June 11, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants