sp-genesis-builder: some doc added

paritytech · Dec 14, 2023 · 249b813 · 249b813
1 parent 2b4626c
commit 249b813
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/substrate/primitives/genesis-builder/src/lib.rs b/substrate/primitives/genesis-builder/src/lib.rs
@@ -19,6 +19,11 @@
 
 //! Substrate genesis config builder
 //!
+//! The runtime may provide a number of partial `GenesisConfig` configurations in form of patches
+//! which shall be applied on top of the default GenesisConfig. This presets are sometimes refered
+//! to as patches. This allows the runtime to provide a number of predefined configuration (e.g. for
+//! different testnets) without leaking the runtime types outside the runtime.
+//!
 //! This Runtime API allows to construct `GenesisConfig`, in particular:
 //! - serialize the runtime default `GenesisConfig` struct into json format,
 //! - put the GenesisConfig struct into the storage. Internally this operation calls