ValidationException(ValidationResult, ValidationAttribute, Object): Incorrect parameter description for "validationResult"

Open Beginner friendly
#12,693 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
csharp
Domain
documentation

Research direction

Open ValidationException.xml from the content source URL and find the constructor overload matching ValidationResult, ValidationAttribute, and Object. Update the validationResult parameter description to explain that it is the result with a validation error, then verify the generated API reference shows the corrected wording.

Written by the indexing model from the issue text.

Description

area-System.ComponentModel.DataAnnotations untriaged
Type of issue

Typo

Description

The description for validationResult reads "The list of validation results.". It should say "the result with a validation error", since it is not a list.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.componentmodel.dataannotations.validationexception.-ctor?view=net-8.0#system-componentmodel-dataannotations-validationexception-ctor(system-componentmodel-dataannotations-validationresult-system-componentmodel-dataannotations-validationattribute-system-object)

Content source URL

https://github.com/dotnet/dotnet-api-docs-temp/blob/live/xml/System.ComponentModel.DataAnnotations/ValidationException.xml

Document Version Independent Id

3835e2b6-232f-3985-766f-4fdc001d58a3

Platform Id

22bc142f-01a3-6a20-8996-a8d75c704306

Article author

@dotnet-bot

Dominant language
C#
Stars
950
Forks
1.7k
Avg merge
3d 5h
Merged PRs (30d)
38

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/dotnet-api-docs

All issues in dotnet/dotnet-api-docs

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.