update doc to be more clear

This commit is contained in:
Nivekithan
2026-04-20 18:55:05 +05:30
parent d12e1e12ae
commit 6b8cb42ee3
+10 -2
View File
@@ -1911,7 +1911,11 @@ pub const fn strict_pow(self, mut exp: u32) -> Self {
}
}
/// Returns the square root of the number, rounded down.
/// Returns the integer square root of the number, rounded down.
///
/// This function returns the **principal (non-negative) square root**.
/// For a given number `n`, although both `x` and `-x` satisfy x<sup>2</sup> = n,
/// this function always returns the non-negative value.
///
/// Returns `None` if `self` is negative.
///
@@ -3206,7 +3210,11 @@ pub const fn pow(self, mut exp: u32) -> Self {
}
}
/// Returns the square root of the number, rounded down.
/// Returns the integer square root of the number, rounded down.
///
/// This function returns the **principal (non-negative) square root**.
/// For a given number `n`, although both `x` and `-x` satisfy x<sup>2</sup> = n,
/// this function always returns the non-negative value.
///
/// # Panics
///