Improve README documentation clarity#503
Open
claudeaceae wants to merge 1 commit intositeline:mainfrom
Open
Conversation
- Add explanation of v26 unified versioning system to prevent confusion - Clarify when to use scope: .ancestor with better explanation - Update library author version range example to be more current - Fix minor hyphenation inconsistencies (opt-in, future-proof) This addresses potential confusion around the version jump from v18 to v26 and improves clarity for developers using the ancestor scope feature. Generated with Claude Code Co-Authored-By: Claude Opus 4.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.
Summary
This PR improves the README documentation to address potential confusion and enhance clarity for developers:
scope: .ancestor: Adds clearer explanation and inline comment for when/why to use the ancestor scope parameterMotivation
While reviewing the README, I noticed that the version jump from
.v18to.v26could be confusing to developers unfamiliar with Apple's 2025 unified versioning system. The scope parameter explanation was also a bit terse and could benefit from additional context.Changes
Test plan
Generated with Claude Code