From f98746ba6c19a2f9243f49a4660e245c54063e6a Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Fri, 15 Mar 2019 07:12:11 +0100
Subject: [PATCH] src/pxar/decoder.rs: improve docu

---
 src/pxar/decoder.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/pxar/decoder.rs b/src/pxar/decoder.rs
index e32520da..463b7d22 100644
--- 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>