fix up docstrings & README

JuliaIO · Jun 8, 2021 · 4919ece · 4919ece
1 parent 78640d8
commit 4919ece
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -63,8 +63,12 @@ recreated. The `skeleton` and `predicate` arguments cannot be used together.
 ### Tar.extract
 
 ```jl
-extract([ predicate, ] tarball, [ dir ];
-        [ skeleton, ] [ copy_symlinks ]) -> dir
+extract(
+    [ predicate, ] tarball, [ dir ];
+    [ skeleton = <none>, ]
+    [ copy_symlinks = <auto>, ]
+    [ set_permissions = true, ]
+) -> dir
 ```
 * `predicate       :: Header --> Bool`
 * `tarball         :: Union{AbstractString, AbstractCmd, IO}`

diff --git a/src/Tar.jl b/src/Tar.jl
@@ -166,9 +166,12 @@ function list(
 end
 
 """
-    extract([ predicate, ] tarball, [ dir ];
-            [ skeleton, ] [ copy_symlinks ],
-            [ set_permissions ]) -> dir
+    extract(
+        [ predicate, ] tarball, [ dir ];
+        [ skeleton = <none>, ]
+        [ copy_symlinks = <auto>, ]
+        [ set_permissions = true, ]
+    ) -> dir
 
         predicate       :: Header --> Bool
         tarball         :: Union{AbstractString, AbstractCmd, IO}