Skip to content

Commit c4139a9

Browse files
authored
fix: Added missing terminology descriptions (#1600)
# Goal The goal of this PR is to add descriptions for Capacity terminology Closes #1542
1 parent 9cd63ec commit c4139a9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pallets/capacity/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
//! - staking and, updating,
3232
//!
3333
//! ## Terminology
34-
//! * **Staker:** [insert description].
35-
//! * **Target** [insert description].
36-
//! * **Epoch Period:** [insert description here].
37-
//! * **Capacity:** [insert description here].
38-
//! * **Replenishable:** [insert description here].
34+
//! * **Capacity:** A refillable and non-transferable resource that can be used to pay for transactions on the network.
35+
//! * **Staker:** An account that stakes tokens to the Frequency network in exchange for Capacity.
36+
//! * **Target** A provider MSA account that receives Capacity.
37+
//! * **Epoch Period:** The length of an epoch in blocks, used for replenishment and thawing.
38+
//! * **Replenishable:** The ability of a provider MSA account to be refilled with Capacity after an epoch period.
3939
//!
4040
// Substrate macros are tripping the clippy::expect_used lint.
4141
#![allow(clippy::expect_used)]

0 commit comments

Comments
 (0)