improve docs

anoma · Oct 28, 2022 · 66314cc · 66314cc
1 parent f3fd821
commit 66314cc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/apps/src/lib/cli.rs b/apps/src/lib/cli.rs
@@ -1669,12 +1669,14 @@ 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 \
-                     a required parameter.",
+                     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(
                     "The path to the validity predicate WASM code to be used \

diff --git 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,