rust-lang / rust-lang/rustc-hash
Better note limitations and purpose of the hash
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 596
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
It came up in https://github.com/rust-lang/rustc-hash/pull/56#issuecomment-2667670854 that someone had problems because the hash broke over a minor release. I think that's fine for the intended purpose of the hash (hashmaps), but this should be better explained in the readme.
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
Read the README and the discussion linked from the issue, especially the concern about hashes breaking across minor releases. Update the README to explain the hash's intended hashmap purpose and its limitations, including that stability across minor releases is not guaranteed; done means these expectations are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100