Skip to content

Commit

Permalink
fix: Added missing terminology descriptions (#1600)
Browse files Browse the repository at this point in the history
# Goal
The goal of this PR is to add descriptions for Capacity terminology

Closes #1542
  • Loading branch information
rlaferla authored and shannonwells committed Apr 16, 2024
1 parent 8ee78e6 commit 53916e9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pallets/capacity/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
//! - staking and, updating,
//!
//! ## Terminology
//! * **Staker:** [insert description].
//! * **Target** [insert description].
//! * **Epoch Period:** [insert description here].
//! * **Capacity:** [insert description here].
//! * **Replenishable:** [insert description here].
//! * **Capacity:** A refillable and non-transferable resource that can be used to pay for transactions on the network.
//! * **Staker:** An account that stakes tokens to the Frequency network in exchange for Capacity.
//! * **Target** A provider MSA account that receives Capacity.
//! * **Epoch Period:** The length of an epoch in blocks, used for replenishment and thawing.
//! * **Replenishable:** The ability of a provider MSA account to be refilled with Capacity after an epoch period.
//!
// Substrate macros are tripping the clippy::expect_used lint.
#![allow(clippy::expect_used)]
Expand Down

0 comments on commit 53916e9

Please sign in to comment.