Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

digest: improve documentation and test examples in readme #1110

Open
newpavlov opened this issue Sep 15, 2022 · 1 comment
Open

digest: improve documentation and test examples in readme #1110

newpavlov opened this issue Sep 15, 2022 · 1 comment
Labels
digest Hash function crate

Comments

@newpavlov
Copy link
Member

newpavlov commented Sep 15, 2022

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.

@tarcieri
Copy link
Member

Here's one approach I've taken to doctesting READMEs by creating a tiny cargo project with the necessary dependencies that embeds the README.md: https://github.com/RustCrypto/password-hashes/tree/master/.readme

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
digest Hash function crate
Projects
None yet
Development

No branches or pull requests

3 participants
@tarcieri @newpavlov and others