added: help description

Author: Vsevolod

module/move/gspread/src/actions/gspread_cell_get.rs

@@ -37,10 +37,7 @@ mod private
         Some( values ) => Ok( values.get( 0 ).unwrap().get( 0 ).unwrap().clone() ),
         None => Ok( JsonValue::Null.clone() )
       }
-      Err( error ) =>
-      {
-        Err( Error::ApiError( error ) )
-      }
+      Err( error ) => Err( Error::ApiError( error ) )
     }
 
   }

module/move/gspread/src/actions/gspread_cell_set.rs

@@ -49,10 +49,7 @@ mod private
           None => Err( Error::CellError( "Some problem with cell updating".to_string() ) )
         }
       }
-      Err( error) =>
-      {
-        Err( Error::ApiError( error ) )
-      }
+      Err( error) => Err( Error::ApiError( error ) )
     }
 
   }

module/move/gspread/src/commands/gspread.rs

@@ -22,35 +22,41 @@ mod private
   #[ derive( Debug, Parser ) ]
   pub struct CommonArgs
   {
-    #[ arg( long ) ]
+    #[ arg( long, help = "Full URL of Google Sheet.\n\
+    It has to be inside of '' to avoid parse errors.\n\
+    Example: 'https://docs.google.com/spreadsheets/d/your_spreadsheet_id/edit?gid=0#gid=0'" ) ]
     pub url : String,
 
-    #[ arg( long ) ]
+    #[ arg( long, help = "Sheet name.\nExample: List1" ) ]
     pub tab : String
   }
 
   #[ derive( Debug, Subcommand ) ]
   pub enum Command
   {
-
+    
+    /// Command to get header of a sheet. Header is a first raw.
     #[ command ( name = "header" ) ]
     Header
     (
       CommonArgs
     ),
 
+    /// Command to get all raws of a sheet but not header.
     #[ command( name = "rows" ) ]
     Rows
     (
       CommonArgs
     ),
 
+    /// Command to get or update a cell from a sheet.
     #[ command ( subcommand, name = "cell" ) ]
     Cell
     (
       gspread_cell::Commands
     ),
 
+    /// Commands to set a new value to a cell or get a value from a cell.
     #[ command ( subcommand, name = "cells" ) ]
     Cells
     (

module/move/gspread/src/commands/gspread_cell.rs

@@ -15,32 +15,42 @@ mod private
   #[ derive( Debug, Subcommand ) ]
   pub enum Commands
   {
+    /// Command to get a value from a sheet's cell
     #[ command( name = "get" ) ]
     Get
     {
-      #[ arg( long ) ]
+      #[ arg( long, help = "Full URL of Google Sheet.\n\
+      It has to be inside of '' to avoid parse errors.\n\
+      Example: 'https://docs.google.com/spreadsheets/d/your_spreadsheet_id/edit?gid=0#gid=0'" ) ]
       url : String,
 
-      #[ arg( long ) ]
+      #[ arg( long, help = "Sheet name.\nExample: List1" ) ]
       tab : String,
 
-      #[ arg( long ) ]
-      cel : String,
+      #[ arg( long, help = "Cell id. You can set it in format:\n \
+      - A1, where A is column name and 1 is row number\n\
+      Example: --cell A4" ) ]
+      cell : String,
     },
 
+    /// Command to set a new value to a sheet's cell.
     #[ command( name = "set" ) ]
     Set
     {
-      #[ arg( long ) ]
+      #[ arg( long, help = "Full URL of Google Sheet.\n\
+      It has to be inside of '' to avoid parse errors.\n\
+      Example: 'https://docs.google.com/spreadsheets/d/your_spreadsheet_id/edit?gid=0#gid=0'" ) ]
       url : String,
 
-      #[ arg( long ) ]
+      #[ arg( long, help = "Sheet name.\nExample: List1" ) ]
       tab : String,
 
-      #[ arg( long ) ]
-      cel : String,
+      #[ arg( long, help = "Cell id. You can set it in format:\n \
+      - A1, where A is column name and 1 is row number\n\
+      Example: --cell A4" ) ]
+      cell : String,
 
-      #[ arg( long ) ]
+      #[ arg( long, help = "Value you want to set. It can be written on any language.\nExample: --val hello" ) ]
       val : String
     }
   }
@@ -53,7 +63,7 @@ mod private
   {
     match commands
     {
-      Commands::Get { url, tab, cel } =>
+      Commands::Get { url, tab, cell } =>
       {
         let spreadsheet_id = match get_spreadsheet_id_from_url( url.as_str() ) 
         {
@@ -70,16 +80,16 @@ mod private
           hub,
           spreadsheet_id,
           tab.as_str(),
-          cel.as_str()
+          cell.as_str()
         )
         .await
         {
           Ok( value ) => println!( "Value: {}", value ),
-          Err( error ) => println!( "Error: {}", error ),
+          Err( error ) => println!( "Error:\n{}", error ),
         }
       },
 
-      Commands::Set { url, tab, cel, val } =>
+      Commands::Set { url, tab, cell, val } =>
       {
         let spreadsheet_id = match get_spreadsheet_id_from_url( url.as_str() ) 
         {
@@ -96,7 +106,7 @@ mod private
           hub,
           spreadsheet_id,
           tab.as_str(),
-          cel.as_str(),
+          cell.as_str(),
           val.as_str()
         )
         .await

module/move/gspread/src/commands/gspread_cells.rs

@@ -13,19 +13,31 @@ mod private
   #[ derive( Debug, Subcommand ) ]
   pub enum Commands
   {
+    /// Command to set values range to a google sheet
     #[ command( name = "set" ) ]
     Set
     {
-      #[ arg( long ) ]
+      #[ arg( long, help = "Identifier of a row. Available identifiers: id (row's unique identifier).\n\
+      Example: --select_row_by_key \"id\"" ) ]
       select_row_by_key : String,
-
-      #[ arg( long ) ]
+      
+      #[ arg( long, help = "Value range. It must contain select_row_by_key.
+      The key is a column name (not a header name, but a column name, which can only contain Latin letters).
+      Every key and value must be a string.
+      Depending on the shell, different handling might be required.\n\
+      Examples:\n\
+      1. --json '\"id\": \"3\", \"A\": \"1\", \"B\": \"2\"'\n\
+      2. --json \"\"id\": \"3\", \"A\": \"1\", \"B\": \"2\"\"\n\
+      3. --json '\\\"id\\\": \\\"3\\\", \\\"A\\\": \\\"1\\\", \\\"B\\\": \\\"2\\\"'\n\
+      4. --json \"\\\"id\\\": \\\"3\\\", \\\"A\\\": \\\"1\\\", \\\"B\\\": \\\"2\\\"\" " ) ]
       json : String,
 
-      #[ arg( long ) ]
+      #[ arg( long, help = "Full URL of Google Sheet.\n\
+      It has to be inside of '' to avoid parse errors.\n\
+      Example: 'https://docs.google.com/spreadsheets/d/your_spreadsheet_id/edit?gid=0#gid=0'" ) ]
       url : String,
 
-      #[ arg( long ) ]
+      #[ arg( long, help = "Sheet name.\nExample: List1" ) ]
       tab : String
     }