Minor documentation fixes (#671)

This commit is contained in:
Aaron Feickert 2024-07-30 00:11:26 -05:00 committed by GitHub
parent 35e78b21ef
commit a7a9fffdc9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions

View file

@ -19,8 +19,8 @@
//! ## Equality Testing //! ## Equality Testing
//! //!
//! The `EdwardsPoint` struct implements the [`subtle::ConstantTimeEq`] //! The `EdwardsPoint` struct implements the [`subtle::ConstantTimeEq`]
//! trait for constant-time equality checking, and the Rust `Eq` trait //! trait for constant-time equality checking, and also uses this to
//! for variable-time equality checking. //! ensure `Eq` equality checking runs in constant time.
//! //!
//! ## Cofactor-related functions //! ## Cofactor-related functions
//! //!
@ -438,7 +438,7 @@ impl Zeroize for CompressedEdwardsY {
#[cfg(feature = "zeroize")] #[cfg(feature = "zeroize")]
impl Zeroize for EdwardsPoint { impl Zeroize for EdwardsPoint {
/// Reset this `CompressedEdwardsPoint` to the identity element. /// Reset this `EdwardsPoint` to the identity element.
fn zeroize(&mut self) { fn zeroize(&mut self) {
self.X.zeroize(); self.X.zeroize();
self.Y = FieldElement::ONE; self.Y = FieldElement::ONE;

View file

@ -76,9 +76,9 @@
//! coordinates without requiring an inversion, so it is much faster. //! coordinates without requiring an inversion, so it is much faster.
//! //!
//! The `RistrettoPoint` struct implements the //! The `RistrettoPoint` struct implements the
//! `subtle::ConstantTimeEq` trait for constant-time equality //! [`subtle::ConstantTimeEq`] trait for constant-time equality
//! checking, and the Rust `Eq` trait for variable-time equality //! checking, and also uses this to ensure `Eq` equality checking
//! checking. //! runs in constant time.
//! //!
//! ## Scalars //! ## Scalars
//! //!