From 019b81aa20058ff210874a0097e1d651f92ee4b8 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 23 Oct 2019 19:48:56 +0000 Subject: [PATCH] Clarify docs for the choice of sign for MontgomeryPoint.to_edwards(). --- src/montgomery.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/montgomery.rs b/src/montgomery.rs index cfed310..79897b1 100644 --- a/src/montgomery.rs +++ b/src/montgomery.rs @@ -104,6 +104,11 @@ impl MontgomeryPoint { /// Attempt to convert to an `EdwardsPoint`, using the supplied /// choice of sign for the `EdwardsPoint`. /// + /// # Inputs + /// + /// * `sign`: a `u8` donating the desired sign of the resulting + /// `EdwardsPoint`. `0` denotes positive and `1` negative. + /// /// # Return /// /// * `Some(EdwardsPoint)` if `self` is the \\(u\\)-coordinate of a