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

Mention in doc comment that len field of scrypt::Params is used only in PasswordHasher #449

Open
sorairolake opened this issue Aug 9, 2023 · 1 comment

Comments

@sorairolake
Copy link
Contributor

I know this has already been mentioned in the comment.

#[allow(dead_code)] // this field is used only with the `PasswordHasher` impl
pub(crate) len: usize,

However, doc comments of Params::new and Params::RECOMMENDED_LEN does not mention this. So, I suggest mentioning this in doc comments as well. I think this makes it easier to understand that len parameter of Params::new is used only in PasswordHasher and any value is meaningless when PasswordHasher is not used.

@tarcieri
Copy link
Member

tarcieri commented Aug 9, 2023

#415 expressed some similar concerns/confusion

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

No branches or pull requests

2 participants