Document copy()

Raku · Aug 28, 2015 · 12172fc · 12172fc
1 parent 7678c0f
commit 12172fc
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/Type/IO/Path.pod b/lib/Type/IO/Path.pod
@@ -265,6 +265,16 @@ operation could not be completed.
 Please use L<move|/routine/move> if a file could not be moved by renaming
 (usually because the destination is on a different physical storage device).
 
+=head2 routine copy
+
+    method copy(IO::Path:D: $to, :$createonly)
+    sub    copy($from, $to, :$createonly);
+
+Copies a file, as indicated by C<$from> or the invocant, to the
+destination specified.  If C<:createonly> is set to C<True>, copy fails if a file
+already exists in the destination.  Returns C<True> upon success, or an
+appropriate C<Failure> if the operation could not be completed.
+
 =head2 routine move
 
     method move(IO::Path:D: $to, :$createonly)