Add docs

cholcombe973 · Jun 21, 2016 · 39cc607 · 39cc607
1 parent 543e0ae
commit 39cc607
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1230,6 +1230,9 @@ fn parse_volume_status(output_str: String)->Result<Vec<BrickStatus>, GlusterErro
 
 }
 
+/// Query the status of the volume given.
+/// # Failures
+/// Will return GlusterError if the command fails to run
 pub fn volume_status(volume: &str) -> Result<Vec<BrickStatus>, GlusterError>{
     let mut arg_list: Vec<String>  = Vec::new();
     arg_list.push("vol".to_string());