From fe008cca6782805c6a179fcd174cc6aa16f41dd5 Mon Sep 17 00:00:00 2001 From: mokurin000 <1348292515a@gmail.com> Date: Sat, 2 Aug 2025 11:01:34 +0800 Subject: [PATCH] docs: fix incorrect comment on machine_readable --- sdgb-cli/src/commands.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/sdgb-cli/src/commands.rs b/sdgb-cli/src/commands.rs index 98dda09..c3cd87f 100644 --- a/sdgb-cli/src/commands.rs +++ b/sdgb-cli/src/commands.rs @@ -5,7 +5,9 @@ use strum::EnumString; #[derive(Parser)] #[command(about = "SDGB api tool", long_about = env!("CARGO_PKG_DESCRIPTION"))] pub struct Cli { - /// try to generate human readable output. + /// Try to generate machine readable format. + /// + /// You must specify this for `-f, --format` to take effect. #[arg(short = 'M', long)] pub machine_readable: bool, #[command(subcommand)] @@ -50,7 +52,7 @@ pub enum Commands { /// JSON format. /// /// `origin`: official json response - /// + /// /// `dx_rating_net`: DxRatingNet Format #[arg(short, long, default_value_t = RatingFormat::default())] format: RatingFormat,