mirror of
https://github.com/arabianq/pipewire-soundpad.git
synced 2026-07-26 21:57:05 +00:00
docs(cli): stop the group descriptions from going stale
Each of the three groups listed its subcommands by hand, and all three lists had drifted: `get` advertised a `current-file-path` that does not exist while omitting tracks, outputs, hotkeys and both new volumes; `set` omitted loop, output and hotkeys; `action` omitted kill, toggle-loop and the hotkey commands. Replaced the hand-kept lists with a short description of what each group is for. Clap already prints the real subcommands underneath, so duplicating them in the parent was guaranteed to rot. Also `save-daemon-config`, an action, was described as "Daemon configuration", which says nothing about what it does. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -15,17 +15,17 @@ struct Cli {
|
|||||||
|
|
||||||
#[derive(Subcommand, Debug)]
|
#[derive(Subcommand, Debug)]
|
||||||
enum Commands {
|
enum Commands {
|
||||||
/// Perform an action (ping, pause, resume, toggle-pause, stop, play)
|
/// Tell the player to do something: play, stop, pause, manage hotkeys
|
||||||
Action {
|
Action {
|
||||||
#[clap(subcommand)]
|
#[clap(subcommand)]
|
||||||
action: Actions,
|
action: Actions,
|
||||||
},
|
},
|
||||||
/// Get information from the player (is paused, volume, position, duration, state, current-file-path, input, inputs)
|
/// Read player state: volumes, position, tracks, devices, hotkeys
|
||||||
Get {
|
Get {
|
||||||
#[clap(subcommand)]
|
#[clap(subcommand)]
|
||||||
parameter: GetCommands,
|
parameter: GetCommands,
|
||||||
},
|
},
|
||||||
/// Set information in the player (volume, position, input)
|
/// Change player settings: volumes, position, devices, loop, hotkeys
|
||||||
Set {
|
Set {
|
||||||
#[clap(subcommand)]
|
#[clap(subcommand)]
|
||||||
parameter: SetCommands,
|
parameter: SetCommands,
|
||||||
@@ -69,7 +69,7 @@ enum Actions {
|
|||||||
#[clap(short, long)]
|
#[clap(short, long)]
|
||||||
id: Option<u32>,
|
id: Option<u32>,
|
||||||
},
|
},
|
||||||
/// Daemon configuration
|
/// Write the daemon's current settings to disk
|
||||||
SaveDaemonConfig,
|
SaveDaemonConfig,
|
||||||
/// Play a sound by hotkey slot name
|
/// Play a sound by hotkey slot name
|
||||||
PlayHotkey { slot: String },
|
PlayHotkey { slot: String },
|
||||||
|
|||||||
Reference in New Issue
Block a user