From a7a9fffdc98cea50c24b5cdaa0da706b01ed48df Mon Sep 17 00:00:00 2001 From: Aaron Feickert <66188213+AaronFeickert@users.noreply.github.com> Date: Tue, 30 Jul 2024 00:11:26 -0500 Subject: [PATCH] Minor documentation fixes (#671) --- curve25519-dalek/src/edwards.rs | 6 +++--- curve25519-dalek/src/ristretto.rs | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/curve25519-dalek/src/edwards.rs b/curve25519-dalek/src/edwards.rs index 856fac1..3210288 100644 --- a/curve25519-dalek/src/edwards.rs +++ b/curve25519-dalek/src/edwards.rs @@ -19,8 +19,8 @@ //! ## Equality Testing //! //! The `EdwardsPoint` struct implements the [`subtle::ConstantTimeEq`] -//! trait for constant-time equality checking, and the Rust `Eq` trait -//! for variable-time equality checking. +//! trait for constant-time equality checking, and also uses this to +//! ensure `Eq` equality checking runs in constant time. //! //! ## Cofactor-related functions //! @@ -438,7 +438,7 @@ impl Zeroize for CompressedEdwardsY { #[cfg(feature = "zeroize")] impl Zeroize for EdwardsPoint { - /// Reset this `CompressedEdwardsPoint` to the identity element. + /// Reset this `EdwardsPoint` to the identity element. fn zeroize(&mut self) { self.X.zeroize(); self.Y = FieldElement::ONE; diff --git a/curve25519-dalek/src/ristretto.rs b/curve25519-dalek/src/ristretto.rs index c9d16ab..5f4e582 100644 --- a/curve25519-dalek/src/ristretto.rs +++ b/curve25519-dalek/src/ristretto.rs @@ -76,9 +76,9 @@ //! coordinates without requiring an inversion, so it is much faster. //! //! The `RistrettoPoint` struct implements the -//! `subtle::ConstantTimeEq` trait for constant-time equality -//! checking, and the Rust `Eq` trait for variable-time equality -//! checking. +//! [`subtle::ConstantTimeEq`] trait for constant-time equality +//! checking, and also uses this to ensure `Eq` equality checking +//! runs in constant time. //! //! ## Scalars //!