From ffb175577e0755ca93140ff334051ecf3fd4f6e7 Mon Sep 17 00:00:00 2001 From: Kris Nuttycombe Date: Mon, 4 Mar 2024 13:30:15 -0700 Subject: [PATCH] Apply documentation suggestions from code review. Co-authored-by: str4d --- zcash_client_backend/src/data_api.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/zcash_client_backend/src/data_api.rs b/zcash_client_backend/src/data_api.rs index dc3b575b8b..eb39226f03 100644 --- a/zcash_client_backend/src/data_api.rs +++ b/zcash_client_backend/src/data_api.rs @@ -494,9 +494,13 @@ pub trait WalletRead { /// Verifies that the given seed corresponds to the viewing key for the specified account. /// - /// Returns `Ok(true)` if the viewing key for the specified account can be derived from - /// the provided seed, `Ok(false)` if the derived seed does not match or the specified - /// account is not present in the database, or an error in the case + /// Returns: + /// - `Ok(true)` if the viewing key for the specified account can be derived from the + /// provided seed. + /// - `Ok(false)` if the derived seed does not match, or the specified account is not + /// present in the database. + /// - `Err(_)` if a Unified Spending Key cannot be derived from the seed for the + /// specified account. fn validate_seed( &self, account_id: Self::AccountId,