Repository: alexcrichton/tar-rs (language: rust)

Issue:
Clear documentation of append_dir() / append_path() about recursiveness
The functions `append_dir` and `append_path`, add `path` to the archive if it's a `file`, otherwise, these functions add an entry if it's a `dir`. I think it should be mentioned in the documentation. 

Only `append_dir_all` adds contents recursively. It is mentioned.


Discussion / hints:

Fix patch:
diff --git a/src/builder.rs b/src/builder.rs
index 34e33e1b..9d6ecc69 100644
--- a/src/builder.rs
+++ b/src/builder.rs
@@ -203,6 +203,9 @@ impl<W: Write> Builder<W> {
     /// so if the archive is in the middle of a read or some other similar
     /// operation then this may corrupt the archive.
     ///
+    /// Note if the `path` is a directory. This will just add an entry to the archive,
+    /// rather than contents of the directory.  
+    ///
     /// Also note that after all files have been written to an archive the
     /// `finish` function needs to be called to finish writing the archive.
     ///
@@ -274,6 +277,9 @@ impl<W: Write> Builder<W> {
     /// so if the archive is in the middle of a read or some other similar
     /// operation then this may corrupt the archive.
     ///
+    /// Note this will not add the contents of the directory to the archive.
+    /// See `append_dir_all` for recusively adding the contents of the directory.
+    ///
     /// Also note that after all files have been written to an archive the
     /// `finish` function needs to be called to finish writing the archive.
     ///


Test patch: