search

rust-lang / rustc-stable-hash

A stable hashing algorithm used by rustc: cross-platform, deterministic, not secure
Apache License 2.0
5 stars 3 forks source link

Improve documentation and add examples #3

Closed Urgau closed 3 months ago

Urgau commented 3 months ago

This PR improves the documentation of the public methods of StableHasher and adds some usage examples.

cc @weihanglo r? @WaffleLapkin Fixes #2

Urgau commented 3 months ago

4 was merged, I have rebased this PR over main, CI is green and I think https://github.com/rust-lang/rustc-stable-hash/pull/3#discussion_r1647713568 can be handled as a follow-up (rather than holding this PR). I think this is ready be merged.

@WaffleLapkin @michaelwoerister any objections?

michaelwoerister commented 3 months ago

@Urgau, I left a couple of remarks but nothing blocking. I'm good with merging the PR, looks great!