tfld/listload
0
0
Fork 0
mirror of https://github.com/TeFiLeDo/listload.git synced 2024-11-01 01:56:17 +01:00
Code

update documentation & manifest

Browse Source
This commit is contained in:
Adrian Wannenmacher 2023-06-28 00:21:20 +02:00
parent 72820bf48a
commit e6ef57b261
Signed by: tfld
GPG Key ID: 19D986ECB1E492D5
2 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Cargo.toml
View File

@ -3,6 +3,9 @@ name = "listload"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
license = "EUPL-1.2" license = "EUPL-1.2"
authors = ["Adrian Wannenmacher <tfld@tfld.dev>"]
description = "Download a list of predefined files."
repository = "https://github.com/TeFiLeDo/listload"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

22
src/main.rs
View File

@ -209,12 +209,12 @@ enum CMD {
/// The name of the target list. Defaults to the selected list. /// The name of the target list. Defaults to the selected list.
name: Option<String>, name: Option<String>,
}, },
/// Target list operations. /// Create, select, modify, … a target list.
List { List {
#[clap(subcommand)] #[clap(subcommand)]
cmd: ListCommand, cmd: ListCommand,
}, },
/// Individual target operations. /// Create, select, modify, … a target in the selected target list.
Target { Target {
#[clap(subcommand)] #[clap(subcommand)]
cmd: TargetCommand, cmd: TargetCommand,
@ -223,9 +223,9 @@ enum CMD {
#[derive(Subcommand)] #[derive(Subcommand)]
enum ListCommand { enum ListCommand {
/// Create a new list. /// Create a new target list.
Create { Create {
/// The new lists name. /// A unique name for the target list.
/// ///
/// The name must start with a lowercase letter (`a-z`). After that, it consists of at least /// The name must start with a lowercase letter (`a-z`). After that, it consists of at least
/// one lowercase letter (`a-z`) or number (`0-9`). It may also contain nonconsecutive /// one lowercase letter (`a-z`) or number (`0-9`). It may also contain nonconsecutive
@ -235,21 +235,18 @@ enum ListCommand {
/// ///
/// Invalid examples: none, 14, _hi, hi_, h__i /// Invalid examples: none, 14, _hi, hi_, h__i
name: String, name: String,
/// A comment to remember what the list is meant to do. /// A comment to remember what the target list is meant to do.
#[clap(long, short)] #[clap(long, short)]
comment: Option<String>, comment: Option<String>,
/// Don't select the newly created list. /// Don't select the newly created target list.
#[clap(long, short)] #[clap(long, short)]
keep_current_selected: bool, keep_current_selected: bool,
}, },
/// Select an existing list. /// Select an existing target list.
///
/// List selection is important for the `target` subcommand.
Select { Select {
/// The name of the list. /// The unique name of the target list.
/// ///
/// The special value `none` deselects all lists. /// The special value `none` unselects the current selection.
#[clap(group = "target")]
name: String, name: String,
}, },
} }
@ -270,7 +267,6 @@ enum TargetCommand {
keep_current_selected: bool, keep_current_selected: bool,
}, },
/// Select an existing target. /// Select an existing target.
/// Target selection is important for the `url` subcommand.
Select { Select {
/// The index of the target. /// The index of the target.
index: usize, index: usize,