pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-04-26 04:07:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Markdown linter (#1309)

Browse Source 
* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
This commit is contained in:
Chevdor
2023-09-04 11:02:32 +02:00
committed by GitHub
parent 830fde2a60
commit a30092ab42
271 changed files with 6289 additions and 4450 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/system/README.md
+16 -20
View File
@@ -1,20 +1,20 @@
# System Module
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.
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/pallet/trait.Config.html)
## Overview
The System module defines the core data types used in a Substrate runtime.
It also provides several utility functions (see [`Pallet`](https://docs.rs/frame-system/latest/frame_system/pallet/struct.Pallet.html)) for other FRAME pallets.
The System module defines the core data types used in a Substrate runtime. It also provides several utility functions
(see [`Pallet`](https://docs.rs/frame-system/latest/frame_system/pallet/struct.Pallet.html)) for other FRAME pallets.
In addition, it manages the storage items for extrinsics data, indexes, event records, and digest items,
among other things that support the execution of the current block.
In addition, it manages the storage items for extrinsics data, indexes, event records, and digest items, among other
things that support the execution of the current block.
It also handles low-level tasks like depositing logs, basic set up and take down of
temporary storage entries, and access to previous block hashes.
It also handles low-level tasks like depositing logs, basic set up and take down of temporary storage entries, and
access to previous block hashes.
## Interface
@@ -24,26 +24,22 @@ The System module does not implement any dispatchable functions.
### Public Functions
See the [`Pallet`](https://docs.rs/frame-system/latest/frame_system/pallet/struct.Pallet.html) struct for details of publicly available functions.
See the [`Pallet`](https://docs.rs/frame-system/latest/frame_system/pallet/struct.Pallet.html) struct for details of
publicly available functions.
### Signed Extensions
The System module defines the following extensions:
- [`CheckWeight`]: Checks the weight and length of the block and ensure that it does not
exceed the limits.
- [`CheckNonce`]: Checks the nonce of the transaction. Contains a single payload of type
`T::Nonce`.
- [`CheckWeight`]: Checks the weight and length of the block and ensure that it does not exceed the limits.
- [`CheckNonce`]: Checks the nonce of the transaction. Contains a single payload of type `T::Nonce`.
- [`CheckEra`]: Checks the era of the transaction. Contains a single payload of type `Era`.
- [`CheckGenesis`]: Checks the provided genesis hash of the transaction. Must be a part of the
signed payload of the transaction.
- [`CheckSpecVersion`]: Checks that the runtime version is the same as the one used to sign the
transaction.
- [`CheckTxVersion`]: Checks that the transaction version is the same as the one used to sign the
- [`CheckGenesis`]: Checks the provided genesis hash of the transaction. Must be a part of the signed payload of the
transaction.
- [`CheckSpecVersion`]: Checks that the runtime version is the same as the one used to sign the transaction.
- [`CheckTxVersion`]: Checks that the transaction version is the same as the one used to sign the transaction.
Lookup the runtime aggregator file (e.g. `node/runtime`) to see the full list of signed
extensions included in a chain.
Lookup the runtime aggregator file (e.g. `node/runtime`) to see the full list of signed extensions included in a chain.
## Usage