From 2badedec343faf537b3af03c7d69ee2409d84938 Mon Sep 17 00:00:00 2001
From: dignifiedquire <me@dignifiedquire.com>
Date: Sat, 6 Jul 2024 19:59:03 +0200
Subject: [PATCH] add doc comments

---
 src/traits/keys.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/traits/keys.rs b/src/traits/keys.rs
index 2525117a..adc78172 100644
--- a/src/traits/keys.rs
+++ b/src/traits/keys.rs
@@ -20,8 +20,10 @@ pub trait PublicKeyParts {
         (self.n().bits() as usize + 7) / 8
     }
 
+    /// Returns the parameters for montgomery operations.
     fn n_params(&self) -> BoxedMontyParams;
 
+    /// Returns precision (in bits) of `n`.
     fn n_bits_precision(&self) -> u32 {
         self.n().bits_precision()
     }
@@ -47,7 +49,10 @@ pub trait PrivateKeyParts: PublicKeyParts {
     /// Returns an iterator over the CRT Values
     fn crt_values(&self) -> Option<&[CrtValue]>;
 
+    /// Returns the params for `p` if precomupted.
     fn p_params(&self) -> Option<&BoxedMontyParams>;
+
+    /// Returns the params for `q` if precomupted.
     fn q_params(&self) -> Option<&BoxedMontyParams>;
 }