Better note limitations and purpose of the hash

Open Beginner friendly
#58 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
documentation

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.

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.

Dominant language
Rust
Stars
596
Forks
62
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/rustc-hash

All issues in rust-lang/rustc-hash

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.