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

Add an example of peppering to the docs. #559

Merged
merged 2 commits into from
Feb 14, 2025
Merged

Conversation

sp1ff
Copy link
Contributor

@sp1ff sp1ff commented Feb 13, 2025

This patch adds an example of peppering as well as salting a password to the library's documentation home page (right under the existing example of salting). I think this is useful because although the new_with_secret() method is public & documented, it's purpose is not clear to the general user.

In fact, it took me a while to spelunk through the project to figure it out.

This patch adds an example of peppering as well as salting a
password to the library's documentation home page (right under the
existing example of salting). I think this is useful because
although the `new_with_secret()` method is public & documented,
it's purpose is not clear to the general user.
@newpavlov newpavlov merged commit 510a3a6 into RustCrypto:master Feb 14, 2025
18 checks passed
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.

2 participants