Apply documentation suggestions from code review.

Co-authored-by: str4d <[email protected]>
nuttycom · Mar 4, 2024 · ffb1755 · ffb1755
1 parent e4c0b0e
commit ffb1755
Showing 1 changed file with 7 additions and 3 deletions.
diff --git 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,