Skip to content

Commit

Permalink
docs: Fix broken documentation links for pallets (paritytech#13241)
Browse files Browse the repository at this point in the history
Fixes broken links to `Config` and `Call`, for READMEs the link has
been fixed by adding the missing "/pallet" path, and for rust docs we
let the compiler figure out the type's link by itself

Signed-off-by: Jonathas-Conceicao <jonathasaoc@gmail.com>
  • Loading branch information
Jonathas-Conceicao authored and ltfschoen committed Feb 22, 2023
1 parent 548bc09 commit 393d062
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 15 deletions.
4 changes: 2 additions & 2 deletions frame/multisig/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Multisig Module
A module for doing multisig dispatch.

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

## Overview

Expand Down
3 changes: 0 additions & 3 deletions frame/multisig/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@
//! number of signed origins.
//! * `approve_as_multi` - Approve a call from a composite origin.
//! * `cancel_as_multi` - Cancel a call from a composite origin.
//!
//! [`Call`]: ./enum.Call.html
//! [`Config`]: ./trait.Config.html

// Ensure we're `no_std` when compiling for Wasm.
#![cfg_attr(not(feature = "std"), no_std)]
Expand Down
4 changes: 2 additions & 2 deletions frame/nicks/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Nicks Module

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

## Overview

Expand Down
4 changes: 2 additions & 2 deletions frame/proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ 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)
- [`Call`](https://docs.rs/pallet-proxy/latest/pallet_proxy/enum.Call.html)
- [`Config`](https://docs.rs/pallet-proxy/latest/pallet_proxy/pallet/trait.Config.html)
- [`Call`](https://docs.rs/pallet-proxy/latest/pallet_proxy/pallet/enum.Call.html)

## Overview

Expand Down
4 changes: 2 additions & 2 deletions frame/sudo/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Sudo Module

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

## Overview

Expand Down
4 changes: 2 additions & 2 deletions frame/utility/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Utility Module
A stateless module with helpers for dispatch management which does no re-authentication.

- [`utility::Config`](https://docs.rs/pallet-utility/latest/pallet_utility/trait.Config.html)
- [`Call`](https://docs.rs/pallet-utility/latest/pallet_utility/enum.Call.html)
- [`utility::Config`](https://docs.rs/pallet-utility/latest/pallet_utility/pallet/trait.Config.html)
- [`Call`](https://docs.rs/pallet-utility/latest/pallet_utility/pallet/enum.Call.html)

## Overview

Expand Down
4 changes: 2 additions & 2 deletions frame/vesting/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Vesting Module

- [`vesting::Config`](https://docs.rs/pallet-vesting/latest/pallet_vesting/trait.Config.html)
- [`Call`](https://docs.rs/pallet-vesting/latest/pallet_vesting/enum.Call.html)
- [`Config`](https://docs.rs/pallet-vesting/latest/pallet_vesting/pallet/trait.Config.html)
- [`Call`](https://docs.rs/pallet-vesting/latest/pallet_vesting/pallet/enum.Call.html)

## Overview

Expand Down

0 comments on commit 393d062

Please sign in to comment.