Skip to content

sha3: improve hasher usage documentation#895

Closed
weifanglab wants to merge 1 commit into
RustCrypto:masterfrom
weifanglab:master
Closed

sha3: improve hasher usage documentation#895
weifanglab wants to merge 1 commit into
RustCrypto:masterfrom
weifanglab:master

Conversation

@weifanglab

Copy link
Copy Markdown

Summary

  • Link the SHA-3 and Keccak hasher types to the Digest trait so their usage is discoverable from the generated API documentation.
  • Update the README example to demonstrate both the one-shot digest interface and incremental hashing with multiple update calls.
  • Correct the Sha3_512 documentation, which incorrectly described it as a SHA-3-256 hasher.

Closes #441.

Testing

  • cargo +1.85.0 test -p sha3 --all-features --locked
  • cargo test -p sha3 --all-features --locked
  • cargo doc -p sha3 --all-features --no-deps --locked
  • cargo fmt --all -- --check
  • git diff --check

Signed-off-by: weifanglab <weifanglab@outlook.com>
@newpavlov newpavlov closed this Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs for hasher states could use a reference to the Digest trait

2 participants