Skip to content

Commit 5f9e753

Browse files
committed
Document rmdir
1 parent 83b681a commit 5f9e753

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

lib/Type/IO.pod

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,16 @@ L<umask|http://en.wikipedia.org/wiki/Umask>).
347347
Throws an exception of type L<X::IO::Mkdir|/type/X::IO::Mkdir> if the
348348
directory cannot be created.
349349
350+
=head2 sub rmdir
351+
352+
sub rmdir($dir as IO --> Bool) is export
353+
354+
Remove the given directory if it is empty.
355+
356+
Returns C<True> on success. Throws an exception of type
357+
L<X::IO::Rmdir|/type/X::IO::Rmdir> if the directory cannot be removed (e.g.
358+
the directory is not empty, or the path is not a directory).
359+
350360
=head2 sub run
351361
352362
sub run(*@args ($, *@)) returns Proc::Status:D

0 commit comments

Comments
 (0)