From 59b94f10c3691894646bbb58fdf43fa9c47dc885 Mon Sep 17 00:00:00 2001 From: brentstone Date: Thu, 27 Oct 2022 20:17:44 -0400 Subject: [PATCH] improve docs --- apps/src/lib/cli.rs | 4 ++-- proof_of_stake/src/lib.rs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/src/lib/cli.rs b/apps/src/lib/cli.rs index 9488f9fcec9..4c26108112f 100644 --- a/apps/src/lib/cli.rs +++ b/apps/src/lib/cli.rs @@ -1668,11 +1668,11 @@ pub mod args { )) .arg(COMMISSION_RATE.def().about( "The commission rate charged by the validator for \ - delegation rewards. This is a required parameter.", + delegation rewards. Expressed as a decimal between 0 and 1. This is a required parameter.", )) .arg(MAX_COMMISSION_RATE_CHANGE.def().about( "The maximum change per epoch in the commission rate \ - charged by the validator for delegation rewards. This is \ + charged by the validator for delegation rewards. Expressed as a decimal between 0 and 1. This is \ a required parameter.", )) .arg(VALIDATOR_CODE_PATH.def().about( diff --git a/proof_of_stake/src/lib.rs b/proof_of_stake/src/lib.rs index 1aad8b6a6ef..e12c0cdd0aa 100644 --- a/proof_of_stake/src/lib.rs +++ b/proof_of_stake/src/lib.rs @@ -753,7 +753,7 @@ pub trait PosBase { key: &Self::Address, value: &CommissionRates, ); - /// Write PoS validator's commission rate. + /// Write PoS validator's maximum change in the commission rate. fn write_validator_max_commission_rate_change( &mut self, key: &Self::Address,