Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.
Prev Previous commit
Next Next commit
improve run_cmd docs
  • Loading branch information
yjhmelody committed Mar 28, 2023
commit 4c4d4a7f2125be6d2430b714e3e5fb8967fc35e7
12 changes: 6 additions & 6 deletions client/cli/src/commands/run_cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ pub struct RunCmd {

/// The human-readable name for this node.
///
/// The node name will be reported to the telemetry server, if enabled.
/// It's used as network node name.
#[arg(long, value_name = "NAME")]
pub name: Option<String>,

Expand Down Expand Up @@ -174,6 +174,10 @@ pub struct RunCmd {
#[clap(flatten)]
pub pool_config: TransactionPoolParams,

#[allow(missing_docs)]
#[clap(flatten)]
pub keystore_params: KeystoreParams,

/// Shortcut for `--name Alice --validator` with session keys for `Alice` added to keystore.
#[arg(long, conflicts_with_all = &["bob", "charlie", "dave", "eve", "ferdie", "one", "two"])]
pub alice: bool,
Expand Down Expand Up @@ -211,10 +215,6 @@ pub struct RunCmd {
#[arg(long)]
pub force_authoring: bool,

#[allow(missing_docs)]
#[clap(flatten)]
pub keystore_params: KeystoreParams,

/// The size of the instances cache for each runtime.
///
/// The default value is 8 and the values higher than 256 are ignored.
Expand Down Expand Up @@ -334,7 +334,7 @@ impl CliConfiguration for RunCmd {
let keyring = self.get_keyring();
let is_authority = self.validator || is_dev || keyring.is_some();

Ok(if is_authority { sc_service::Role::Authority } else { sc_service::Role::Full })
Ok(if is_authority { Role::Authority } else { Role::Full })
}

fn force_authoring(&self) -> Result<bool> {
Expand Down
2 changes: 1 addition & 1 deletion client/cli/src/params/prometheus_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub struct PrometheusParams {
}

impl PrometheusParams {
/// Creates configuration about Prometheus.
/// Creates [`PrometheusConfig`].
pub fn prometheus_config(
&self,
default_listen_port: u16,
Expand Down