src/pxar/decoder.rs: improve docu

2019-03-15 07:12:11 +01:00 · 2019-03-15 07:12:11 +01:00 · f98746ba6c
commit f98746ba6c
parent 0b2d7fdc81
1 changed files with 4 additions and 1 deletions
--- a/src/pxar/decoder.rs
+++ b/src/pxar/decoder.rs
@ -228,9 +228,12 @@ impl <'a, R: Read> PxarDecoder<'a, R> {
        Ok(())
    }

+    /// Restore an archive into the specified directory.
+    ///
+    /// The directory is created if it does not exist.
    pub fn restore<F>(
        &mut self,
-        path: &Path, // used for error reporting
+        path: &Path,
        callback: &F,
    ) -> Result<(), Error>
        where F: Fn(&Path) -> Result<(), Error>