Skip to content

Commit

Permalink
age: Adjust scrypt::Identity::set_max_work_factor docs
Browse files Browse the repository at this point in the history
They are now consistent with `scrypt::Recipient::set_work_factor`.
  • Loading branch information
str4d committed Aug 28, 2024
1 parent 7019aa2 commit 7e67717
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions age/src/scrypt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,13 +196,13 @@ impl Identity {
}
}

/// Sets the maximum accepted scrypt work factor to `2^max_work_factor`.
/// Sets the maximum accepted scrypt work factor to `N = 2^max_log_n`.
///
/// This method must be called before [`Self::unwrap_stanza`] to have an effect.
///
/// [`Self::unwrap_stanza`]: crate::Identity::unwrap_stanza
pub fn set_max_work_factor(&mut self, max_work_factor: u8) {
self.max_work_factor = max_work_factor;
pub fn set_max_work_factor(&mut self, max_log_n: u8) {
self.max_work_factor = max_log_n;
}
}

Expand Down

0 comments on commit 7e67717

Please sign in to comment.