Apply suggestions from code review

Co-authored-by: Daira Emma Hopwood <[email protected]>
nuttycom · Oct 26, 2023 · 5a2f008 · 5a2f008
1 parent f1c0869
commit 5a2f008
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/zcash_client_backend/src/data_api/wallet.rs b/zcash_client_backend/src/data_api/wallet.rs
@@ -381,8 +381,8 @@ where
 /// Returns the proposal, which may then be executed using [`create_proposed_transaction`]
 ///
 /// Parameters:
-/// * `wallet_db`: A read/write reference to the wallet database
-/// * `params`: Consensus parameters
+/// * `wallet_db`: A read/write reference to the wallet database.
+/// * `params`: Consensus parameters.
 /// * `fee_rule`: The fee rule to use in creating the transaction.
 /// * `spend_from_account`: The unified account that controls the funds that will be spent
 ///   in the resulting transaction. This procedure will return an error if the

diff --git a/zcash_client_backend/src/fees/standard.rs b/zcash_client_backend/src/fees/standard.rs
@@ -17,7 +17,7 @@ use zcash_primitives::{
 
 use super::{fixed, zip317, ChangeError, ChangeStrategy, DustOutputPolicy, TransactionBalance};
 
-/// A change strategy that and proposes change as a single output to the most current supported
+/// A change strategy that proposes change as a single output to the most current supported
 /// shielded pool and delegates fee calculation to the provided fee rule.
 pub struct SingleOutputChangeStrategy {
     fee_rule: StandardFeeRule,

diff --git a/zcash_primitives/CHANGELOG.md b/zcash_primitives/CHANGELOG.md
@@ -80,6 +80,7 @@ and this library adheres to Rust's notion of
 
 ### Added
 - `transaction::fees::StandardFeeRule`
+
 ## [0.13.0] - 2023-09-25
 ### Added
 - `zcash_primitives::consensus::BlockHeight::saturating_sub`

diff --git a/zcash_primitives/src/transaction/fees.rs b/zcash_primitives/src/transaction/fees.rs
@@ -60,9 +60,9 @@ pub trait FutureFeeRule: FeeRule {
 /// An enumeration of the standard fee rules supported by the wallet.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum StandardFeeRule {
-    #[deprecated(note = "It is recommended to use `StandardFeeRule::Zip317` instead.")]
+    #[deprecated(note = "Using this fee rule violates ZIP 317, and might cause transactions built with it to fail. Use `StandardFeeRule::Zip317` instead.")]
     PreZip313,
-    #[deprecated(note = "It is recommended to use `StandardFeeRule::Zip317` instead.")]
+    #[deprecated(note = "Using this fee rule violates ZIP 317, and might cause transactions built with it to fail. Use `StandardFeeRule::Zip317` instead.")]
     Zip313,
     Zip317,
 }