Skip to content

Commit

Permalink
polish public docs
Browse files Browse the repository at this point in the history
Signed-off-by: Iulian Barbu <[email protected]>
  • Loading branch information
iulianbarbu committed Nov 28, 2024
1 parent 06bbd5e commit d6faae7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
13 changes: 8 additions & 5 deletions cumulus/polkadot-omni-node/lib/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,11 +126,14 @@ pub struct Cli<Config: CliConfig> {

/// 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<u64>,

/// EXPERIMENTAL: Use slot-based collator which can handle elastic scaling.
Expand Down
4 changes: 3 additions & 1 deletion substrate/client/cli/src/params/shared_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down

0 comments on commit d6faae7

Please sign in to comment.