Repository navigation
(PATCH): Fix API names in the docs - #74
Merged
Merged
Conversation
The README told readers to use IPatchObjectFor<T>, and the getting started guide called patch.ApplyTo(person). Neither exists — the interface is IPatchObject<T> and its method is Patch(target) — so both snippets fail to compile as written. The sample controller carried the same wrong name in a comment above a line that uses the real one. Docs and comments only; no behaviour change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RtsmxAyPuVHce2nkVDZh2v
✅ PR Title Formatted CorrectlyThe title of this PR has been updated to match the correct format. Thank you! |
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
2 participants
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 README and getting-started guide name types and methods that don't exist, so both PATCH snippets fail to compile as written. Spotted while working on #73; split out here so that PR stays focused.
The errors
README.md(prose bullet)IPatchObjectFor<PersonWriteModel>IPatchObject<PersonWriteModel>README.md(snippet — comment and parameter)IPatchObjectFor<PersonWriteModel>IPatchObject<PersonWriteModel>docs/getting-started.md(snippet)patch.ApplyTo(person)patch.Patch(person)PTrampert.SimplePatch.Sample/Controllers/PeopleController.cs(comment)IPatchObjectFor<PersonWriteModel>IPatchObject<PersonWriteModel>The interface is
IPatchObject<T>and its single method isT Patch(T target). The sample's comment is the same wrong name sitting directly above a line that already uses the real one, so it was worth fixing in the same pass — the README's snippet is a copy of that controller.Docs and comments only; no behaviour change. Build is clean and the 23 existing tests pass.
Not touched
PatchJsonConverterFactoryTests.Deserialize_ToIPatchObjectFor_ReturnsObjectWithCorrectOptionalPropertiesstill carries the old name. That's a test method identifier rather than documentation, so I left it rather than widen a docs fix into test code — happy to rename it if you'd like it gone too.Relationship to #73
Branched from
main, not from #73, so the two can merge in either order. #73 appends a new OpenAPI section to the end ofREADME.mdand does not touch these lines, so no conflict either way.🤖 Generated with Claude Code
https://claude.ai/code/session_01RtsmxAyPuVHce2nkVDZh2v
Generated by Claude Code