Update wrappers README to cover wrapper versioning#240
Merged
Conversation
jorajeev
reviewed
Jan 13, 2026
| ``` | ||
| [dependencies] | ||
| tokio = { package = "shuttle-tokio", version = "0.1.0" } | ||
| tokio-version-importer-do-not-use-directly = { version = "=1.36.0" } |
Member
There was a problem hiding this comment.
This looks ugly - how about just writing
tokio = { package = ... }
tokio-version-pin = { version = "=1.36.0" }
Contributor
Author
There was a problem hiding this comment.
It being ugly is the point ? It's to protect against accidentally using it
jorajeev
reviewed
Jan 27, 2026
wrappers/README.md
Outdated
| ```toml | ||
| [features] | ||
| shuttle = [ | ||
| "PACKAGE_NAME/shuttle", |
Member
There was a problem hiding this comment.
I still find this hard to read - since PACKAGE_NAME is a placeholder (i.e., acts like a variable).
I think this would be a lot more readable if we just used specific examples - users are smart enough to generalize:
shuttle = [
"shuttle-tokio/shuttle",
"shuttle-parking_lot/shuttle",
]
etc.
jorajeev
approved these changes
Jan 27, 2026
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.
Covers wrapper versioning.
Could include the alternatives to doing it like this, but that might also just add confusion.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.