Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Fix CI Link Check #7639

Merged
3 commits merged into from
Nov 30, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions frame/assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ with a fixed supply, including:
* Asset Transfer
* Asset Destruction

To use it in your runtime, you need to implement the assets [`Config`](https://docs.rs/pallet-assets/latest/pallet_assets/trait.Config.html).
To use it in your runtime, you need to implement the assets [`assets::Trait`](https://docs.rs/pallet-assets/latest/pallet_assets/trait.Trait.html).

The supported dispatchable functions are documented in the [`Call`](https://docs.rs/pallet-assets/latest/pallet_assets/enum.Call.html) enum.
The supported dispatchable functions are documented in the [`assets::Call`](https://docs.rs/pallet-assets/latest/pallet_assets/enum.Call.html) enum.

### Terminology

Expand Down Expand Up @@ -113,4 +113,4 @@ them are violated, the behavior of this module is undefined.
* [`System`](https://docs.rs/frame-system/latest/frame_system/)
* [`Support`](https://docs.rs/frame-support/latest/frame_support/)

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/atomic-swap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A module for atomically sending funds.

- [`atomic_swap::Config`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Config.html)
- [`atomic_swap::Trait`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/enum.Call.html)
- [`Module`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/struct.Module.html)

Expand All @@ -20,4 +20,4 @@ claimed within a specified duration of time, the sender may cancel it.
* `claim_swap` - called by the target to approve a swap
* `cancel_swap` - may be called by a sender after a specified duration

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/aura/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aura Module

- [`aura::Config`](https://docs.rs/pallet-aura/latest/pallet_aura/trait.Config.html)
- [`aura::Trait`](https://docs.rs/pallet-aura/latest/pallet_aura/trait.Trait.html)
- [`Module`](https://docs.rs/pallet-aura/latest/pallet_aura/struct.Module.html)

## Overview
Expand All @@ -25,4 +25,4 @@ If you're interested in hacking on this module, it is useful to understand the i
[`ProvideInherent`](https://docs.rs/sp-inherents/latest/sp_inherents/trait.ProvideInherent.html) and
[`ProvideInherentData`](https://docs.rs/sp-inherents/latest/sp_inherents/trait.ProvideInherentData.html) to create and check inherents.

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/balances/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Balances module provides functionality for handling accounts and balances.

- [`balances::Config`](https://docs.rs/pallet-balances/latest/pallet_balances/trait.Config.html)
- [`balances::Trait`](https://docs.rs/pallet-balances/latest/pallet_balances/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-balances/latest/pallet_balances/enum.Call.html)
- [`Module`](https://docs.rs/pallet-balances/latest/pallet_balances/struct.Module.html)

Expand Down Expand Up @@ -119,4 +119,4 @@ The Balances module depends on the [`GenesisConfig`](https://docs.rs/pallet-bala

* Total issued balanced of all accounts should be less than `Config::Balance::max_value()`.

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Contract module provides functionality for the runtime to deploy and execute WebAssembly smart-contracts.

- [`contract::Config`](https://docs.rs/pallet-contracts/latest/pallet_contracts/trait.Config.html)
- [`contract::Trait`](https://docs.rs/pallet-contracts/latest/pallet_contracts/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-contracts/latest/pallet_contracts/enum.Call.html)

## Overview
Expand Down Expand Up @@ -61,4 +61,4 @@ WebAssembly based smart contracts in the Rust programming language. This is a wo

* [Balances](https://docs.rs/pallet-balances/latest/pallet_balances/)

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/democracy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Democracy Pallet

- [`democracy::Config`](https://docs.rs/pallet-democracy/latest/pallet_democracy/trait.Config.html)
- [`democracy::Trait`](https://docs.rs/pallet-democracy/latest/pallet_democracy/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-democracy/latest/pallet_democracy/enum.Call.html)

## Overview
Expand Down Expand Up @@ -132,4 +132,4 @@ This call can only be made by the `VetoOrigin`.
- `cancel_queued` - Cancels a proposal that is queued for enactment.
- `clear_public_proposal` - Removes all public proposals.

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/elections-phragmen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ being re-elected at the end of each round.

### Module Information

- [`election_sp_phragmen::Config`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/trait.Config.html)
- [`election_sp_phragmen::Trait`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/enum.Call.html)
- [`Module`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/struct.Module.html)

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/example-offchain-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ concepts, APIs and structures common to most offchain workers.
Run `cargo doc --package pallet-example-offchain-worker --open` to view this module's
documentation.

- [`pallet_example_offchain_worker::Config`](./trait.Config.html)
- [`pallet_example_offchain_worker::Config`](./trait.Trait.html)
bkchr marked this conversation as resolved.
Show resolved Hide resolved
- [`Call`](./enum.Call.html)
- [`Module`](./struct.Module.html)

Expand All @@ -24,4 +24,4 @@ Additional logic in OCW is put in place to prevent spamming the network with bot
and unsigned transactions, and custom `UnsignedValidator` makes sure that there is only
one unsigned transaction floating in the network.

License: Unlicense
License: Unlicense
4 changes: 2 additions & 2 deletions frame/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Copy and paste this template from frame/example/src/lib.rs into file
// Include the following links that shows what trait needs to be implemented to use the pallet
// and the supported dispatchables that are documented in the Call enum.

- \[`<INSERT_CUSTOM_PALLET_NAME>::Config`](https://docs.rs/pallet-example/latest/pallet_example/trait.Config.html)
- \[`<INSERT_CUSTOM_PALLET_NAME>::Trait`](https://docs.rs/pallet-example/latest/pallet_example/trait.Trait.html)
- \[`Call`](https://docs.rs/pallet-example/latest/pallet_example/enum.Call.html)
- \[`Module`](https://docs.rs/pallet-example/latest/pallet_example/struct.Module.html)

Expand Down Expand Up @@ -235,4 +235,4 @@ pub trait Config: <INSERT_CUSTOM_PALLET_NAME>::Config { }
// that the implementation is based on.
</pre></p></details>

License: Unlicense
License: Unlicense
4 changes: 2 additions & 2 deletions frame/identity/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Identity Module

- [`identity::Config`](https://docs.rs/pallet-identity/latest/pallet_identity/trait.Config.html)
- [`identity::Trait`](https://docs.rs/pallet-identity/latest/pallet_identity/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-identity/latest/pallet_identity/enum.Call.html)

## Overview
Expand Down Expand Up @@ -53,4 +53,4 @@ no state-bloat attack is viable.
[`Call`]: ./enum.Call.html
[`Config`]: ./trait.Config.html

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/im-online/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and includes the recent best block number of the local validators chain as well
as the `NetworkState`.
It is submitted as an Unsigned Transaction via off-chain workers.

- [`im_online::Config`](https://docs.rs/pallet-im-online/latest/pallet_im_online/trait.Config.html)
- [`im_online::Trait`](https://docs.rs/pallet-im-online/latest/pallet_im_online/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-im-online/latest/pallet_im_online/enum.Call.html)
- [`Module`](https://docs.rs/pallet-im-online/latest/pallet_im_online/struct.Module.html)

Expand Down Expand Up @@ -48,4 +48,4 @@ decl_module! {

This module depends on the [Session module](https://docs.rs/pallet-session/latest/pallet_session/).

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/multisig/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Multisig Module
A module for doing multisig dispatch.

- [`multisig::Config`](https://docs.rs/pallet-multisig/latest/pallet_multisig/trait.Config.html)
- [`multisig::Trait`](https://docs.rs/pallet-multisig/latest/pallet_multisig/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-multisig/latest/pallet_multisig/enum.Call.html)

## Overview
Expand All @@ -26,4 +26,4 @@ not available or desired.
[`Call`]: ./enum.Call.html
[`Config`]: ./trait.Config.html

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/nicks/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nicks Module

- [`nicks::Config`](https://docs.rs/pallet-nicks/latest/pallet_nicks/trait.Config.html)
- [`nicks::Trait`](https://docs.rs/pallet-nicks/latest/pallet_nicks/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-nicks/latest/pallet_nicks/enum.Call.html)

## Overview
Expand All @@ -22,4 +22,4 @@ have not been designed to be economically secure. Do not use this pallet as-is i
[`Call`]: ./enum.Call.html
[`Config`]: ./trait.Config.html

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The accounts to which permission is delegated may be requied to announce the act
wish to execute some duration prior to execution happens. In this case, the target account may
reject the announcement and in doing so, veto the execution.

- [`proxy::Config`](https://docs.rs/pallet-proxy/latest/pallet_proxy/trait.Config.html)
- [`proxy::Trait`](https://docs.rs/pallet-proxy/latest/pallet_proxy/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-proxy/latest/pallet_proxy/enum.Call.html)

## Overview
Expand All @@ -18,4 +18,4 @@ reject the announcement and in doing so, veto the execution.
[`Call`]: ./enum.Call.html
[`Config`]: ./trait.Config.html

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/recovery/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Recovery Pallet

- [`recovery::Config`](https://docs.rs/pallet-recovery/latest/pallet_recovery/trait.Config.html)
- [`recovery::Trait`](https://docs.rs/pallet-recovery/latest/pallet_recovery/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-recovery/latest/pallet_recovery/enum.Call.html)

## Overview
Expand Down Expand Up @@ -131,4 +131,4 @@ of this pallet are:
* `set_recovered` - The ROOT origin is able to skip the recovery process and directly allow
one account to access another.

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/scheduler/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Scheduler
A module for scheduling dispatches.

- [`scheduler::Config`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Config.html)
- [`scheduler::Trait`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/enum.Call.html)
- [`Module`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/struct.Module.html)

Expand Down Expand Up @@ -31,4 +31,4 @@ then those filter will not be used when dispatching the schedule call.
`Vec<u8>` parameter that can be used for identification.
* `cancel_named` - the named complement to the cancel function.

License: Unlicense
License: Unlicense
4 changes: 2 additions & 2 deletions frame/scored-pool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ time. If an entity is currently a member, this results in removal
from the `Pool` and `Members`; the entity is immediately replaced
by the next highest scoring candidate in the pool, if available.

- [`scored_pool::Config`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/trait.Config.html)
- [`scored_pool::Trait`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/enum.Call.html)
- [`Module`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/struct.Module.html)

Expand Down Expand Up @@ -63,4 +63,4 @@ decl_module! {

This module depends on the [System module](https://docs.rs/frame-system/latest/frame_system/).

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/session/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Session module allows validators to manage their session keys, provides a function for changing
the session length, and handles session rotation.

- [`session::Config`](https://docs.rs/pallet-session/latest/pallet_session/trait.Config.html)
- [`session::Trait`](https://docs.rs/pallet-session/latest/pallet_session/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-session/latest/pallet_session/enum.Call.html)
- [`Module`](https://docs.rs/pallet-session/latest/pallet_session/struct.Module.html)

Expand Down Expand Up @@ -80,4 +80,4 @@ fn validators<T: pallet_session::Config>() -> Vec<<T as pallet_session::Config>:

- [Staking](https://docs.rs/pallet-staking/latest/pallet_staking/)

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/society/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Society Module

- [`society::Config`](https://docs.rs/pallet-society/latest/pallet_society/trait.Config.html)
- [`society::Trait`](https://docs.rs/pallet-society/latest/pallet_society/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-society/latest/pallet_society/enum.Call.html)

## Overview
Expand Down Expand Up @@ -225,4 +225,4 @@ make judgement on a suspended candidate.
* `set_max_membership` - The ROOT origin can update the maximum member count for the society.
The max membership count must be greater than 1.

License: Apache-2.0
License: Apache-2.0
10 changes: 5 additions & 5 deletions frame/staking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Staking module is used to manage funds at stake by network maintainers.

- [`staking::Config`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html)
- [`staking::Trait`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html)
- [`Module`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Module.html)

Expand Down Expand Up @@ -157,7 +157,7 @@ decl_module! {
### Era payout

The era payout is computed using yearly inflation curve defined at
[`T::RewardCurve`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.RewardCurve) as such:
[`T::RewardCurve`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.RewardCurve) as such:

```nocompile
staker_payout = yearly_inflation(npos_token_staked / total_tokens) * total_tokens / era_per_year
Expand All @@ -168,7 +168,7 @@ This payout is used to reward stakers as defined in next section
remaining_payout = max_yearly_inflation * total_tokens / era_per_year - staker_payout
```
The remaining reward is send to the configurable end-point
[`T::RewardRemainder`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.RewardRemainder).
[`T::RewardRemainder`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.RewardRemainder).

### Reward Calculation

Expand Down Expand Up @@ -214,7 +214,7 @@ Any funds already placed into stash can be the target of the following operation

The controller account can free a portion (or all) of the funds using the
[`unbond`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.unbond) call. Note that the funds are not immediately
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.BondingDuration)
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.BondingDuration)
(in number of eras) must pass until the funds can actually be removed. Once the
`BondingDuration` is over, the [`withdraw_unbonded`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.withdraw_unbonded)
call can be used to actually withdraw the funds.
Expand Down Expand Up @@ -246,4 +246,4 @@ The Staking module depends on the [`GenesisConfig`](https://docs.rs/pallet-staki
- [Session](https://docs.rs/pallet-session/latest/pallet_session/): Used to manage sessions. Also, a list of new
validators is stored in the Session module's `Validators` at the end of each era.

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/sudo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sudo Module

- [`sudo::Config`](https://docs.rs/pallet-sudo/latest/pallet_sudo/trait.Config.html)
- [`sudo::Trait`](https://docs.rs/pallet-sudo/latest/pallet_sudo/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-sudo/latest/pallet_sudo/enum.Call.html)

## Overview
Expand Down Expand Up @@ -67,4 +67,4 @@ You need to set an initial superuser account as the sudo `key`.
[`Config`]: ./trait.Config.html
[`Origin`]: https://docs.substrate.dev/docs/substrate-types

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The System module provides low-level access to core types and cross-cutting utilities.
It acts as the base layer for other pallets to interact with the Substrate framework components.

- [`system::Config`](https://docs.rs/frame-system/latest/frame_system/trait.Config.html)
- [`system::Trait`](https://docs.rs/frame-system/latest/frame_system/trait.Trait.html)

## Overview

Expand Down Expand Up @@ -72,4 +72,4 @@ decl_module! {
}
```

License: Apache-2.0
License: Apache-2.0
4 changes: 2 additions & 2 deletions frame/timestamp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Timestamp module provides functionality to get and set the on-chain time.

- [`timestamp::Config`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/trait.Config.html)
- [`timestamp::Trait`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/enum.Call.html)
- [`Module`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/struct.Module.html)

Expand Down Expand Up @@ -71,4 +71,4 @@ the Timestamp module for session management.

* [Session](https://docs.rs/pallet-session/latest/pallet_session/)

License: Apache-2.0
License: Apache-2.0
Loading