From f753e63f3bdbcba3dd84b85a5de93813f9f07f50 Mon Sep 17 00:00:00 2001 From: Deirdre Connolly Date: Wed, 12 Aug 2020 02:21:11 -0400 Subject: [PATCH] Clarify docstring on NoteCommitment::new() --- zebra-chain/src/commitments/sapling.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/zebra-chain/src/commitments/sapling.rs b/zebra-chain/src/commitments/sapling.rs index 5a1195bb..0172abda 100644 --- a/zebra-chain/src/commitments/sapling.rs +++ b/zebra-chain/src/commitments/sapling.rs @@ -70,7 +70,8 @@ impl NoteCommitment { /// Generate a new _NoteCommitment_ and the randomness used to create it. /// /// We return the randomness because it is needed to construct a _Note_, - /// before it is encrypted as part of an _Output Description_. + /// before it is encrypted as part of an _Output Description_. This is a + /// higher level function that calls `NoteCommit^Sapling_rcm` internally. /// /// NoteCommit^Sapling_rcm (g*_d , pk*_d , v) := /// WindowedPedersenCommit_rcm([1; 6] || I2LEBSP_64(v) || g*_d || pk*_d)