GIT-based or "*" version
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 32
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
https://rhai.rs/book/start/install.html#admonition-use-latest-release-version and https://rhai.rs/book/start/install.html#admonition-use-latest-development-version are unfortunate, at least.
Neither works when publishing a (depending) crate to crates.io. The GIT-based-only way is easy to spot, but the "*" is less obvious/known. However, see https://doc.rust-lang.org/nightly/cargo/reference/specifying-dependencies.html#wildcard-requirements > "Note: crates.io does not allow bare * versions.".
Even worse, top level "*" will lead to incompatible changes if (ever) there are higher major versions. And, it can currently lead to less-obvious incompatibilities (even worse, potentially in runtime, since it's scripting....) with any old crates referencing old "0.*.*" versions - but those would not be mixed up if the user would specify "1.*" or (less error-prone) "1.18.*".
Please
- replace
"*"with (more flexible, but more incompatibility-prone)"1.*"and/or (more robust)"1.18.0"(in which case add this file to a list of tasks to do when you release a minor version), and - add a note that with a GIT-only-based dependency it can't be published to crates.io.
If that sounds OK, I'm willing to provide a PR.
Thank you (indeed) for Rhai.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two linked installation-page sections, “Use latest release version” and “Use latest development version,” and review their dependency examples. Update the wildcard guidance and add the crates.io limitation for Git-only dependencies; done means both sections give publishable, version-specific advice.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100