RustCrypto / RustCrypto/traits

digest: improve documentation and test examples in readme

Open
#1,110 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

digest
Dominant language
Rust
Stars
755
Forks
256
Avg merge
1h 27m
Merged PRs (30d)
2

Description

Lack of readme example tests has caused #1072.

Also we probably should unify documentation from the hashes and digest' readmes. I think of having most of docs in the digest's readme, which will be included into digest's docs, and we will reference those examples from the hashes readme and hash implementation crate-level docs.

Including working hash tests into digest's docs will cause a weird dependency cycle digest <- sha2 <- digest, but I think it should work since sha2 and other crates will be dev-dependencies.

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.

Research direction

Compare the hashes README, the digest README, and the hash implementation crate-level documentation to identify duplicated examples and documentation. Start by checking how README content is included in digest's docs and how dev-dependencies affect the proposed digest <- sha2 <- digest cycle. Done means unified documentation with working hash example tests referenced consistently across those locations.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, rust
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.