add doc comments #53

Merged
lx merged 10 commits from trinity-1686a/garage:doc-comments into main 2021-04-08 13:01:22 +00:00
Showing only changes of commit 653d3d588f - Show all commits

View file

@ -1,4 +1,6 @@
#![deny(missing_crate_level_docs, missing_docs)]
#![recursion_limit = "1024"] #![recursion_limit = "1024"]
//! Garage CLI, used to interact with a running Garage instance, and to launch a Garage
trinity-1686a marked this conversation as resolved Outdated
Outdated
Review

"and to launch a Garage instance" ?

"and to launch a Garage **instance**" ?
#[macro_use] #[macro_use]
extern crate log; extern crate log;
@ -25,7 +27,7 @@ use cli::*;
#[derive(StructOpt, Debug)] #[derive(StructOpt, Debug)]
#[structopt(name = "garage")] #[structopt(name = "garage")]
pub struct Opt { struct Opt {
/// RPC connect to this host to execute client operations /// RPC connect to this host to execute client operations
#[structopt(short = "h", long = "rpc-host", default_value = "127.0.0.1:3901")] #[structopt(short = "h", long = "rpc-host", default_value = "127.0.0.1:3901")]
pub rpc_host: SocketAddr, pub rpc_host: SocketAddr,