docs(help): add example

Author: Thaumy

src/args/cmd/ing.rs

@@ -4,12 +4,14 @@ use clap::Parser;
 pub struct Opt {
     #[arg(verbatim_doc_comment)]
     /// Show ing list, order by time in DESC
+    /// Example: cnb ing --list
     #[arg(long)]
     #[arg(short = 'l')]
     pub list: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Publish ing with specific content
+    /// Example: cnb ing --publish 'Hello world'
     /// The visibility of ing is public
     #[arg(long)]
     #[arg(short = 'p')]
@@ -19,6 +21,7 @@ pub struct Opt {
 
     #[arg(verbatim_doc_comment)]
     /// Comment ing with specific content
+    /// Example: cnb --id 114514 ing --comment 'Hello world'
     /// You should also specify the id of ing via option --id
     #[arg(long)]
     #[arg(short = 'c')]

src/args/cmd/post.rs

@@ -4,38 +4,40 @@ use clap::Parser;
 pub struct Opt {
     #[arg(verbatim_doc_comment)]
     /// Show title and content of a specific post
+    /// Example: cnb --id 114514 post --show
     /// You should also specify the id of post via option --id
     #[arg(long)]
     #[arg(short = 's')]
     pub show: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Show metadata of a specific post
+    /// Example: cnb --id 114514 post --show-meta
     /// You should also specify the id of post via option --id
     #[arg(long)]
     #[arg(short = 'm')]
     pub show_meta: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Show post list, order by time in DESC
+    /// Example: cnb post --list
     /// <LENGTH> should in range [0,100]
     /// If <LENGTH> greater than 100, it will be set to 100
     #[arg(long)]
     #[arg(short = 'l')]
-    #[arg(default_missing_value = "8")]
-    #[arg(value_name = "LENGTH")]
     pub list: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Delete post
+    /// Example: cnb --id 114514 post --delete
     /// You should also specify the id of post via option --id
     #[arg(long)]
     #[arg(visible_alias = "del")]
     pub delete: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Search post by keyword and output the post id list that matches
-    /// Example: cnb post --search FOO
+    /// Example: cnb post --search 'Hello world'
     #[arg(long)]
     #[arg(value_name = "KEYWORD")]
     pub search: Option<String>,

src/args/cmd/user.rs

@@ -4,6 +4,7 @@ use clap::Parser;
 pub struct Opt {
     #[arg(verbatim_doc_comment)]
     /// Login with your personal access token (PAT)
+    /// Example: cnb user --login FOOBARBAZ
     /// PAT will be saved in ~/.cnbrc
     /// You can create PAT in https://account.cnblogs.com/tokens
     #[arg(long)]
@@ -12,11 +13,13 @@ pub struct Opt {
 
     #[arg(verbatim_doc_comment)]
     /// Logout and remove ~/.cnbrc
+    /// Example: cnb user --logout
     #[arg(long)]
     pub logout: bool,
 
     #[arg(verbatim_doc_comment)]
     /// Show user info
+    /// Example: cnb user --info
     #[arg(long)]
     #[arg(short = 'i')]
     pub info: bool,