docs(readme): pin the install snippet to 0.0.2 - #10
Merged
Conversation
The snippet asked for magic_notifications ^0.0.1. Dart's caret rules for 0.0.x make that >=0.0.1 <0.0.2, so it excludes this package's own current release.
There was a problem hiding this comment.
Pull request overview
Updates the README install snippet to reference the package’s current release (0.0.2), so readers following the Quick Start get the intended version under Dart’s caret semantics for pre-0.1 packages.
Changes:
- Bumped the README dependency example from
magic_notifications: ^0.0.1to^0.0.2.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
What
README.mdinstall snippet:magic_notifications: ^0.0.1to^0.0.2.Why
^0.0.1resolves to>=0.0.1 <0.0.2under Dart's caret rules for pre-0.1 versions, so the snippet excluded the package's own current release. A reader following the README landed on 0.0.1.Found while correcting
references/plugin-notifications.mdin the magic skill (fluttersdk/magic#114), which had the same class of staleness: it claimed to documentv0.0.1-alpha.1, a pre-release that never shipped, and covered none of the sevennotifications:*commands or the two read-only MCP tools this package contributes.Testing
Documentation only. Version cross-checked against
pubspec.yaml.