From 7d22c174a85245a1e87823e0fa16982e1102a3e0 Mon Sep 17 00:00:00 2001
From: Shun Sakai <sorairolake@protonmail.ch>
Date: Tue, 5 Sep 2023 23:10:06 +0900
Subject: [PATCH] Argon2: Fix docs about minimum value of `m_cost` (#459)

---
 argon2/src/params.rs | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/argon2/src/params.rs b/argon2/src/params.rs
index a65ccbc5..edfc005b 100644
--- a/argon2/src/params.rs
+++ b/argon2/src/params.rs
@@ -12,7 +12,7 @@ use password_hash::{ParamsString, PasswordHash};
 /// These are parameters which can be encoded into a PHC hash string.
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub struct Params {
-    /// Memory size, expressed in kibibytes, between 8 and (2^32)-1.
+    /// Memory size, expressed in kibibytes, between 8\*`p_cost` and (2^32)-1.
     ///
     /// Value is an integer in decimal (1 to 10 digits).
     m_cost: u32,
@@ -100,7 +100,7 @@ impl Params {
     /// Create new parameters.
     ///
     /// # Arguments
-    /// - `m_cost`: memory size in 1 KiB blocks. Between 8 and (2^32)-1.
+    /// - `m_cost`: memory size in 1 KiB blocks. Between 8\*`p_cost` and (2^32)-1.
     /// - `t_cost`: number of iterations. Between 1 and (2^32)-1.
     /// - `p_cost`: degree of parallelism. Between 1 and (2^24)-1.
     /// - `output_len`: size of the KDF output in bytes. Default 32.
@@ -154,7 +154,7 @@ impl Params {
         })
     }
 
-    /// Memory size, expressed in kibibytes. Between 8 and (2^32)-1.
+    /// Memory size, expressed in kibibytes. Between 8\*`p_cost` and (2^32)-1.
     ///
     /// Value is an integer in decimal (1 to 10 digits).
     pub const fn m_cost(&self) -> u32 {
@@ -432,7 +432,7 @@ impl ParamsBuilder {
         Self::DEFAULT
     }
 
-    /// Set memory size, expressed in kibibytes, between 8 and (2^32)-1.
+    /// Set memory size, expressed in kibibytes, between 8\*`p_cost` and (2^32)-1.
     pub fn m_cost(&mut self, m_cost: u32) -> &mut Self {
         self.m_cost = m_cost;
         self