From 425c1df61ec89cffc7f97508d0862f22a80c6161 Mon Sep 17 00:00:00 2001 From: arabian Date: Sun, 26 Jul 2026 21:49:40 +0300 Subject: [PATCH] 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 --- pwsp-cli/src/main.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pwsp-cli/src/main.rs b/pwsp-cli/src/main.rs index a3b648b..fb1c83c 100644 --- a/pwsp-cli/src/main.rs +++ b/pwsp-cli/src/main.rs @@ -15,17 +15,17 @@ struct Cli { #[derive(Subcommand, Debug)] enum Commands { - /// Perform an action (ping, pause, resume, toggle-pause, stop, play) + /// Tell the player to do something: play, stop, pause, manage hotkeys Action { #[clap(subcommand)] 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 { #[clap(subcommand)] parameter: GetCommands, }, - /// Set information in the player (volume, position, input) + /// Change player settings: volumes, position, devices, loop, hotkeys Set { #[clap(subcommand)] parameter: SetCommands, @@ -69,7 +69,7 @@ enum Actions { #[clap(short, long)] id: Option, }, - /// Daemon configuration + /// Write the daemon's current settings to disk SaveDaemonConfig, /// Play a sound by hotkey slot name PlayHotkey { slot: String },