Document that paths use forward slashes

Fixes #24
dagolden · Jun 27, 2018 · 5b9fc9d · 5b9fc9d
1 parent a41197f
commit 5b9fc9d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Changes b/Changes
@@ -2,6 +2,10 @@ Revision history for Path-Iterator-Rule
 
 {{$NEXT}}
 
+    [DOCS]
+
+    - Noted that file separators are unix-style forward slashes.
+
 1.013     2018-06-20 16:48:23-06:00 America/Denver
 
     [CHANGED]

diff --git a/lib/Path/Iterator/Rule.pm b/lib/Path/Iterator/Rule.pm
@@ -780,6 +780,10 @@ Here is a summary of features for comparison to other file finding modules:
 As a convenience, the L<PIR> module is an empty subclass of this one
 that is less arduous to type for one-liners.
 
+B<Note>: paths are constructed with unix-style forward-slashes for
+efficiency rather than using L<File::Spec>.  If proper path separators are
+needed, call L<canonpath|File::Spec/canonpath> on the search results.
+
 =cut
 
 # vim: ts=4 sts=4 sw=4 et: