Skip to content

Commit 30618c5

Browse files
TriplEightdanforbesSteve Degosseriebkchr
authored
CI: markdown link checker (#7145)
* change (CI): markdown link checker * Fix some invalid doc links (re-run of cargo-unleash gen-readme w/ fixes). * Fix some invalid doc links * Fix some invalid doc links * Fix some links * Fix some links * Apply @bkchr suggestions from code review Co-authored-by: Bastian Köcher <[email protected]> * Fix more links * Fix more links * typo * Fix more links * Fix more links * Ignore valid link .. check wrongly sees it as invalid * Fix style issue * Fix style issue * change (CI): update style guide link * change (lib): suggestions Co-authored-by: Dan Forbes <[email protected]> Co-authored-by: Steve Degosserie <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>
1 parent cb1a2a3 commit 30618c5

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ There are three possible roles that any staked account pair can be in: `Validato
5757
and `Idle` (defined in [`StakerStatus`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.StakerStatus.html)). There are three
5858
corresponding instructions to change between roles, namely:
5959
[`validate`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.validate),
60-
[`nominate`](./enum.Call.html#variant.nominate), and [`chill`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.chill).
60+
[`nominate`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.nominate), and [`chill`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.chill).
6161

6262
#### Validating
6363

@@ -81,7 +81,7 @@ between the validator and its nominators. This rule incentivizes the nominators
8181
the misbehaving/offline validators as much as possible, simply because the nominators will also
8282
lose funds if they vote poorly.
8383

84-
An account can become a nominator via the [`nominate`](enum.Call.html#variant.nominate) call.
84+
An account can become a nominator via the [`nominate`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.nominate) call.
8585

8686
#### Rewards and Slash
8787

@@ -102,15 +102,15 @@ Slashing logic is further described in the documentation of the `slashing` modul
102102

103103
Similar to slashing, rewards are also shared among a validator and its associated nominators.
104104
Yet, the reward funds are not always transferred to the stash account and can be configured. See
105-
[Reward Calculation](#reward-calculation) for more details.
105+
[Reward Calculation](https://docs.rs/pallet-staking/latest/pallet_staking/#reward-calculation) for more details.
106106

107107
#### Chilling
108108

109109
Finally, any of the roles above can choose to step back temporarily and just chill for a while.
110110
This means that if they are a nominator, they will not be considered as voters anymore and if
111111
they are validators, they will no longer be a candidate for the next election.
112112

113-
An account can step back via the [`chill`](enum.Call.html#variant.chill) call.
113+
An account can step back via the [`chill`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.chill) call.
114114

115115
### Session managing
116116

@@ -183,7 +183,7 @@ they received during the era. Points are added to a validator using
183183
[`reward_by_ids`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.reward_by_ids) or
184184
[`reward_by_indices`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.reward_by_indices).
185185

186-
[`Module`](./struct.Module.html) implements
186+
[`Module`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Module.html) implements
187187
[`pallet_authorship::EventHandler`](https://docs.rs/pallet-authorship/latest/pallet_authorship/trait.EventHandler.html) to add reward
188188
points to block producer and block producer of referenced uncles.
189189

@@ -198,11 +198,11 @@ validator and all of the nominators that nominated the validator, proportional t
198198
staked behind this validator (_i.e._ dividing the
199199
[`own`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Exposure.html#structfield.own) or
200200
[`others`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Exposure.html#structfield.others) by
201-
[`total`](./struct.Exposure.html#structfield.total) in [`Exposure`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Exposure.html)).
201+
[`total`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Exposure.html#structfield.total) in [`Exposure`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Exposure.html)).
202202

203203
All entities who receive a reward have the option to choose their reward destination through the
204204
[`Payee`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Payee.html) storage item (see
205-
[`set_payee`](enum.Call.html#variant.set_payee)), to be one of the following:
205+
[`set_payee`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.set_payee)), to be one of the following:
206206

207207
- Controller account, (obviously) not increasing the staked value.
208208
- Stash account, not increasing the staked value.
@@ -213,14 +213,14 @@ All entities who receive a reward have the option to choose their reward destina
213213
Any funds already placed into stash can be the target of the following operations:
214214

215215
The controller account can free a portion (or all) of the funds using the
216-
[`unbond`](enum.Call.html#variant.unbond) call. Note that the funds are not immediately
217-
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.BondingDuration.html)
216+
[`unbond`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.unbond) call. Note that the funds are not immediately
217+
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.BondingDuration)
218218
(in number of eras) must pass until the funds can actually be removed. Once the
219219
`BondingDuration` is over, the [`withdraw_unbonded`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.withdraw_unbonded)
220220
call can be used to actually withdraw the funds.
221221

222222
Note that there is a limitation to the number of fund-chunks that can be scheduled to be
223-
unlocked in the future via [`unbond`](enum.Call.html#variant.unbond). In case this maximum
223+
unlocked in the future via [`unbond`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.unbond). In case this maximum
224224
(`MAX_UNLOCKING_CHUNKS`) is reached, the bonded account _must_ first wait until a successful
225225
call to `withdraw_unbonded` to remove some of the chunks.
226226

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@
232232
//!
233233
//! The controller account can free a portion (or all) of the funds using the
234234
//! [`unbond`](enum.Call.html#variant.unbond) call. Note that the funds are not immediately
235-
//! accessible. Instead, a duration denoted by [`BondingDuration`](./struct.BondingDuration.html)
235+
//! accessible. Instead, a duration denoted by [`BondingDuration`](./trait.Trait.html#associatedtype.BondingDuration)
236236
//! (in number of eras) must pass until the funds can actually be removed. Once the
237237
//! `BondingDuration` is over, the [`withdraw_unbonded`](./enum.Call.html#variant.withdraw_unbonded)
238238
//! call can be used to actually withdraw the funds.

0 commit comments

Comments
 (0)