Skip to content

Commit 573e0cf

Browse files
authored
Tweak description of dir in IO::Path doc
1 parent b760f80 commit 573e0cf

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/Type/IO/Path.rakudoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -462,11 +462,12 @@ platforms, e.g. Windows, since C<resolve> assumes POSIX semantics.
462462
multi sub dir(IO() $path, |c)
463463
method dir(IO::Path:D: Mu :$test = $*SPEC.curupdir)
464464

465-
Returns the contents of a directory as a lazy list of C<IO::Path> objects
466-
representing relative paths, filtered by
467-
L<smartmatching|/language/operators#infix_~~> their names (as strings) against
468-
the C<:test> parameter. The path of returned files will be absolute or
469-
relative depending on what C<$path> is, and are returned in an arbitrary order.
465+
Returns a lazy list of C<IO::Path> objects corresponding to the entries in a
466+
directory, optionally filtered by L<smartmatching|/language/operators#infix_~~>
467+
their names I<as strings> per the C<:test> parameter. The order in which the
468+
filesystem returns entries determines the order of the entries/objects in the
469+
list. Objects corresponding to special directory entries C<.> and C<..> are not
470+
included. C<$path> determines whether the objects' paths are absolute or relative.
470471

471472
Since the tests are performed against C<Str> arguments, not C<IO>, the tests are
472473
executed in the C<$*CWD>, instead of the target directory. When testing against

0 commit comments

Comments
 (0)