src/cli/getopts.rs: improve docs

src/cli.rs

@@ -7,8 +7,9 @@
 mod environment;
 pub use environment::*;
 
+mod getopts;
+pub use getopts::*;
+
 mod command;
 pub use command::*;
 
-mod getopts;
-pub use getopts::*;

src/cli/getopts.rs

@@ -52,6 +52,10 @@ fn parse_argument(arg: &str) -> RawArgument {
     };
 }
 
+/// Parses command line arguments using a `Schema`
+///
+/// Returns parsed options as json object, together with the
+/// list of additional command line arguments.
 pub fn parse_arguments<T: AsRef<str>>(
     args: &[T],
     arg_param: &Vec<&'static str>,