From 7508fce6b67b4350bda547980408af55835a28f7 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Tue, 27 Feb 2024 16:03:24 +0000 Subject: [PATCH] Documentation fixes --- Sources/ZcashLightClientKit/Synchronizer.swift | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Sources/ZcashLightClientKit/Synchronizer.swift b/Sources/ZcashLightClientKit/Synchronizer.swift index 79bdd067..6d0c4716 100644 --- a/Sources/ZcashLightClientKit/Synchronizer.swift +++ b/Sources/ZcashLightClientKit/Synchronizer.swift @@ -207,7 +207,7 @@ public protocol Synchronizer: AnyObject { /// - Parameter toAddress: the recipient's address. /// - Parameter memo: an `Optional`with the memo to include as part of the transaction. send `nil` when sending to transparent receivers otherwise the function will throw an error /// - /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws + /// If `prepare()` hasn't already been called since creation of the synchronizer instance or since the last wipe then this method throws /// `SynchronizerErrors.notPrepared`. @available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.") func sendToAddress( @@ -220,8 +220,9 @@ public protocol Synchronizer: AnyObject { /// Shields transparent funds from the given private key into the best shielded pool of the account associated to the given `UnifiedSpendingKey`. /// - Parameter spendingKey: the `UnifiedSpendingKey` that allows to spend transparent funds /// - Parameter memo: the optional memo to include as part of the transaction. + /// - Parameter shieldingThreshold: the minimum transparent balance required before a transaction will be created. /// - /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws + /// If `prepare()` hasn't already been called since creation of the synchronizer instance or since the last wipe then this method throws /// `SynchronizerErrors.notPrepared`. @available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.") func shieldFunds( @@ -275,7 +276,7 @@ public protocol Synchronizer: AnyObject { /// Returns the latests UTXOs for the given address from the specified height on /// - /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws + /// If `prepare()` hasn't already been called since creation of the synchronizer instance or since the last wipe then this method throws /// `SynchronizerErrors.notPrepared`. func refreshUTXOs(address: TransparentAddress, from height: BlockHeight) async throws -> RefreshedUTXOs @@ -299,7 +300,7 @@ public protocol Synchronizer: AnyObject { /// `rewind(policy:)` itself doesn't start the sync process when it's done and it doesn't trigger notifications as regorg would. After it is done /// you have start the sync process by calling `start()` /// - /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then returned publisher emits + /// If `prepare()` hasn't already been called since creation of the synchronizer instance or since the last wipe then returned publisher emits /// `SynchronizerErrors.notPrepared` error. /// /// - Parameter policy: the rewind policy