Skip to content

Commit ec61476

Browse files
authored
Merge pull request #163 from Screenly/fix/help_texts
Adds: missing help texts
2 parents 488ecbd + 4e352e9 commit ec61476

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

src/cli.rs

+14-6
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,10 @@ pub enum Commands {
5757
/// Asset related commands.
5858
#[command(subcommand)]
5959
Asset(AssetCommands),
60+
/// Playlist related commands.
6061
#[command(subcommand)]
6162
Playlist(PlaylistCommands),
63+
/// Edge App related commands.
6264
#[command(subcommand)]
6365
EdgeApp(EdgeAppCommands),
6466
}
@@ -368,6 +370,7 @@ pub enum EdgeAppCommands {
368370

369371
#[derive(Subcommand, Clone, PartialEq, Eq, PartialOrd, Ord)]
370372
pub enum EdgeAppVersionCommands {
373+
/// Lists Edge App versions.
371374
List {
372375
/// Edge app id. If not specified CLI will use the id from the manifest.
373376
#[arg(short, long)]
@@ -381,6 +384,7 @@ pub enum EdgeAppVersionCommands {
381384
#[arg(short, long, action = clap::ArgAction::SetTrue)]
382385
json: Option<bool>,
383386
},
387+
/// Promotes Edge App revision to channel.
384388
Promote {
385389
/// Edge app revision to promote.
386390
#[arg(short, long)]
@@ -389,10 +393,11 @@ pub enum EdgeAppVersionCommands {
389393
#[arg(short, long, default_value = "stable")]
390394
channel: String,
391395

392-
/// Edge App Installation id. If app_id is specified, installation_id must be also specified. If both are not specified, CLI will use the installation_id from the manifest
396+
/// Edge App Installation id. If not specified, CLI will use the installation_id from the manifest.
393397
#[arg(short, long)]
394398
installation_id: Option<String>,
395399

400+
/// Use the latest revision of the Edge App.
396401
#[arg(long, action = clap::ArgAction::SetTrue, conflicts_with = "revision", default_value="false")]
397402
latest: bool,
398403

@@ -404,26 +409,27 @@ pub enum EdgeAppVersionCommands {
404409

405410
#[derive(Subcommand, Clone, PartialEq, Eq, PartialOrd, Ord)]
406411
pub enum EdgeAppSettingsCommands {
412+
/// Lists Edge App settings.
407413
List {
408414
/// Path to the directory with the manifest. If not specified CLI will use the current working directory.
409415
#[arg(short, long)]
410416
path: Option<String>,
411417

412-
/// Edge App Installation id. If app_id is specified, installation_id must be also specified. If both are not specified, CLI will use the installation_id from the manifest
418+
/// Edge App Installation id. If not specified, CLI will use the installation_id from the manifest.
413419
#[arg(short, long)]
414420
installation_id: Option<String>,
415421

416422
/// Enables JSON output.
417423
#[arg(short, long, action = clap::ArgAction::SetTrue)]
418424
json: Option<bool>,
419425
},
420-
426+
/// Sets Edge App setting.
421427
Set {
422428
/// Key value pair of the setting to be set in the form of `key=value`.
423429
#[arg(value_parser = parse_key_val)]
424430
setting_pair: (String, String),
425431

426-
/// Edge App Installation id. If app_id is specified, installation_id must be also specified. If both are not specified, CLI will use the installation_id from the manifest
432+
/// Edge App Installation id. If not specified, CLI will use the installation_id from the manifest.
427433
#[arg(short, long)]
428434
installation_id: Option<String>,
429435

@@ -435,25 +441,27 @@ pub enum EdgeAppSettingsCommands {
435441

436442
#[derive(Subcommand, Clone, PartialEq, Eq, PartialOrd, Ord)]
437443
pub enum EdgeAppSecretsCommands {
444+
/// Lists Edge App secrets.
438445
List {
439446
/// Path to the directory with the manifest. If not specified CLI will use the current working directory.
440447
#[arg(short, long)]
441448
path: Option<String>,
442449

443-
/// Edge App Installation id. If app_id is specified, installation_id must be also specified. If both are not specified, CLI will use the installation_id from the manifest
450+
/// Edge App Installation id. If not specified, CLI will use the installation_id from the manifest.
444451
#[arg(short, long)]
445452
installation_id: Option<String>,
446453

447454
/// Enables JSON output.
448455
#[arg(short, long, action = clap::ArgAction::SetTrue)]
449456
json: Option<bool>,
450457
},
458+
/// Sets Edge App secret.
451459
Set {
452460
/// Key value pair of the secret to be set in the form of `key=value`.
453461
#[arg(value_parser = parse_key_val)]
454462
secret_pair: (String, String),
455463

456-
/// Edge App Installation id. If app_id is specified, installation_id must be also specified. If both are not specified, CLI will use the installation_id from the manifest
464+
/// Edge App Installation id. If not specified, CLI will use the installation_id from the manifest.
457465
#[arg(short, long)]
458466
installation_id: Option<String>,
459467

0 commit comments

Comments
 (0)