docs for hasher states could use a reference to the `Digest` trait
Maintainers usually reply within 1 day
Nobody has claimed this yet.
- #895 by @weifanglab — closed without merging
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- rust
- Domain
- cryptography, documentation
Research direction
Start by reviewing the documentation for hasher state types such as sha3::Keccak256 and the existing examples using Digest::update. Add a reference to the Digest trait, show a one-shot Keccak256::digest example, and use multiple messages in incremental examples so the distinction is clear. The documentation is done when newcomers can understand both usage patterns.
Written by the indexing model from the issue text.
Description
For someone new to the ecosystem it might be hard to tell how to use a... For example, sha3::Keccak256 (https://docs.rs/sha3/latest/sha3/type.Keccak256.html), it's just a type alias with no real info about what it is (other than some nebulous "hasher state") or how to use it. I'd recommend linking to the Digest trait in the docs as a way of explaining "how to use it"
Additionally (if I should move this to a separate issue, let me know and I will do so) I would recommend an example specifically showing how to sha3::Keccak256::digest(b"a message") in one go. Finally, the example(s) that use update should add more than one message. This would be so that show new user why you would use new and then update rather than digest ("because you can add more than one thing").
I would be willing to create the examples / documentation if this would be agreeable
- Dominant language
- Rust
- Stars
- 2.3k
- Forks
- 343
- Avg merge
- 1h 27m
- Merged PRs (30d)
- 5
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from RustCrypto/hashes
-
`blake2::Blake2b512` does not implement `ZeroizeOnDrop`Possibly taken @Johnsonajibi claimed this 39 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 68/100
RustCrypto/hashes#912 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
RustCrypto/hashes#909 · 4 comments ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
RustCrypto/hashes#908 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
RustCrypto/hashes#763 · 1 comment ·
Maintainers usually reply within 1 day
-
blake2: implement `CustomizedInit` using `digest` macroMay be free again @MavenRain claimed this 73 days ago, and no pull request is open. Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
RustCrypto/hashes#747 · 1 comment ·
Maintainers usually reply within 1 day
All issues in RustCrypto/hashes
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
eclipse-opensovd/classic-diagnostic-adapter#616 ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
track: content
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
0xAndersen/witness-log#10 ·
-
follow-up main-defect wave-A
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
carrick-sh/carrick#249 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
lugassawan/swe-workbench#799 ·
Maintainers usually reply within 1 day