Repository navigation
Fix doc gaps, add a package description, extend license year - #89
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README said tuples are walked in one section and not walked in another. Name the Tuple classes, which are walked, and value tuples, which are not. Say what Validator.TryValidateObject leaves out instead of linking the ASP.NET Core 3.1 docs, and show the usage as C#. The package had no description, so nuget.org showed "Package Description". Put Fixed after Changed in the changelog. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Motivation
The docs fell behind the 3.0 walk changes. The README said tuples are walked in one section and not walked in another. Its opening paragraph linked the ASP.NET Core 3.1 docs, and its usage sample passed an undefined variable. The package has never had a description, so nuget.org shows "Package Description". The LICENSE year for Thomas Harold covers only 2020, but work shipped in 2020, 2022 and 2026.
Summary
Tupleclasses are walked and value tuples are not. Each section now names the type it means. The opening paragraph says whatValidator.TryValidateObjectleaves out, and the usage sample is a C# code block.<Description>.TypeExtensions.csin place of the old recursive description.No library code changes.
Test plan
dotnet packputs the new description in the nuspecIsWalkedTypeand the existingTuple_of_objects_is_still_validatedtestgit diff --checkis clean