From d6faae78623e90ec34135283bbb9cb4f590c3d37 Mon Sep 17 00:00:00 2001 From: Iulian Barbu Date: Thu, 28 Nov 2024 08:47:54 +0000 Subject: [PATCH] polish public docs Signed-off-by: Iulian Barbu --- cumulus/polkadot-omni-node/lib/src/cli.rs | 13 ++++++++----- substrate/client/cli/src/params/shared_params.rs | 4 +++- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/cumulus/polkadot-omni-node/lib/src/cli.rs b/cumulus/polkadot-omni-node/lib/src/cli.rs index 4917ae1dd320..e4052025e240 100644 --- a/cumulus/polkadot-omni-node/lib/src/cli.rs +++ b/cumulus/polkadot-omni-node/lib/src/cli.rs @@ -126,11 +126,14 @@ pub struct Cli { /// Start a dev node that produces a block each `dev_block_time` ms. /// - /// This is a dev option, and it won't result in starting or connecting to a parachain network. - /// The resulting node will work on its own, running the wasm blob and artificially producing - /// a block each `dev_block_time` ms, as if it was part of a parachain. Defaults to 3000ms if - /// not set and `--dev` is used. - #[arg(long)] + /// This is a dev option. It enables a manual sealing, meaning blocks are produced manually + /// rather than being part of an actual network consensus process. Using the option won't + /// result in starting or connecting to a parachain network. The resulting node will work on + /// its own, running the wasm blob and artificially producing a block each `dev_block_time` ms, + /// as if it was part of a parachain. + /// + /// The `--dev` flag sets the `dev_block_time` to a default value of 3000ms unless explicitly + /// provided. #[arg(long)] pub dev_block_time: Option, /// EXPERIMENTAL: Use slot-based collator which can handle elastic scaling. diff --git a/substrate/client/cli/src/params/shared_params.rs b/substrate/client/cli/src/params/shared_params.rs index 5717f567a3ac..e0c52deb44ca 100644 --- a/substrate/client/cli/src/params/shared_params.rs +++ b/substrate/client/cli/src/params/shared_params.rs @@ -35,7 +35,9 @@ pub struct SharedParams { /// /// This flag sets `--chain=dev`, `--force-authoring`, `--rpc-cors=all`, `--alice`, and `--tmp` /// flags, unless explicitly overridden. It also disables local peer discovery (see `--no-mdns` - /// and `--discover-local`). + /// and `--discover-local`). With this flag some nodes might start with manual seal, producing + /// blocks at certain events (e.g. `polkadot-omni-node`, which produces blocks at certain + /// intervals dictated by `--dev-block-time`). #[arg(long)] pub dev: bool,