pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-09 20:11:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

basic improvements to sp-runtime docs (#14583)

Browse Source
This commit is contained in:
Kian Paimani
2023-07-17 11:36:37 +02:00
committed by GitHub
parent d4ad997deb
commit 1a2d59b1af
2 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/primitives/runtime/src/generic/mod.rs
+2 -3
View File
@@ -15,9 +15,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.
// tag::description[]
//! Generic implementations of Extrinsic/Header/Block.
// end::description[]
//! Generic implementations of [`crate::traits::Header`], [`crate::traits::Block`] and
//! [`crate::traits::Extrinsic`].
mod block;
mod checked_extrinsic;
substrate/primitives/runtime/src/lib.rs
+26 -1
View File
@@ -15,7 +15,32 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//! Runtime Modules shared primitive types.
//! # Substrate Runtime Primitives.
//!
//! This crate, among other things, contains a large library of types and utilities that are used in
//! the Substrate runtime, but are not particularly `FRAME`-oriented.
//!
//! ## Block, Header and Extrinsics
//!
//! Most notable, this crate contains some of the types and trait that enable important
//! communication between the client and the runtime. This includes:
//!
//! - A set of traits to declare what any block/header/extrinsic type should provide.
//! - [`traits::Block`], [`traits::Header`], [`traits::Extrinsic`]
//! - A set of types that implement these traits, whilst still providing a high degree of
//! configurability via generics.
//! - [`generic::Block`], [`generic::Header`], [`generic::UncheckedExtrinsic`] and
//! [`generic::CheckedExtrinsic`]
//!
//! ## Runtime API Types
//!
//! This crate also contains some types that are often used in conjuncture with Runtime APIs. Most
//! notable:
//!
//! - [`ApplyExtrinsicResult`], and [`DispatchOutcome`], which dictate how the client and runtime
//! communicate about the success or failure of an extrinsic.
//! - [`transaction_validity`], which dictates how the client and runtime communicate about the
//! validity of an extrinsic while still in the transaction-queue.
#![warn(missing_docs)]
#![cfg_attr(not(feature = "std"), no_std)]