README and examples use unavailable API
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 234
- Forks
- 108
- Avg merge
- 5h 12m
- Merged PRs (30d)
- 4
Description
The README has this example code:
https://github.com/rustls/tokio-rustls/blob/63b8d6f10392c1e7a1c81cf3c526c4d4054ff71d/README.md?plain=1#L22-L23
This API was added in rustls 0.21.6. However, Cargo.toml (for the latest published release) only require rustls 0.21.0, leading to compilation errors if someone updates tokio-rustls without also updating the rustls point release (and the error message does not make it obvious that this is the solution).
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 README example at the linked lines and inspect Cargo.toml for the published rustls dependency version. Verify which rustls release provides the referenced API and determine whether the example or dependency requirement needs to change. Done means the documented example no longer produces an unavailable-API compilation error for users of the latest published release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100