Skip to content

Commit

Permalink
Minor documentation fix and clarification for the data API.
Browse files Browse the repository at this point in the history
Signed-off-by: Daira-Emma Hopwood <daira@katava.local>
  • Loading branch information
Daira-Emma Hopwood committed Nov 4, 2024
1 parent c6db09b commit 539f81d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions zcash_client_backend/src/data_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1209,7 +1209,8 @@ pub trait WalletRead {
/// the maximum index).
///
/// If `index_range` is some `Range`, it limits the result to addresses with indices
/// in that range.
/// in that range. An `index_range` of `None` is defined to be equivalent to
/// `0..(1u32 << 31)`.
///
/// Wallets should scan the chain for UTXOs sent to these ephemeral transparent
/// receivers, but do not need to do so regularly. Under expected usage, outputs
Expand Down Expand Up @@ -1245,9 +1246,8 @@ pub trait WalletRead {
}

/// If a given ephemeral address might have been reserved, i.e. would be included in
/// the map returned by `get_known_ephemeral_addresses(account_id, false)` for any
/// of the wallet's accounts, then return `Ok(Some(account_id))`. Otherwise return
/// `Ok(None)`.
/// the result of `get_known_ephemeral_addresses(account_id, None)` for any of the
/// wallet's accounts, then return `Ok(Some(account_id))`. Otherwise return `Ok(None)`.
///
/// This is equivalent to (but may be implemented more efficiently than):
/// ```compile_fail
Expand Down

0 comments on commit 539f81d

Please sign in to comment.