Merge pull request #9 from magthe/ClarifyRelative

Clarify what limitations the RelX parsers have.
2016-03-04 14:29:52 +01:00
parent 88eb4f32a8 b5cff315a1
commit 04fa5d3ea8
2 changed files with 9 additions and 0 deletions
--- a/src/Path.hs
+++ b/src/Path.hs
@@ -104,6 +104,8 @@ parseAbsDir filepath =
 -- | Get a location for a relative directory. Produces a normalized
 -- path which always ends in a path separator.
 --
+-- Note that @filepath@ may contain any number of @./@ but may not consist solely of @./@.  It also may not contain a single @..@ anywhere.
+--
 -- Throws: 'PathParseException'
 --
 parseRelDir :: MonadThrow m
@@ -136,6 +138,8 @@ parseAbsFile filepath =

 -- | Get a location for a relative file.
 --
+-- Note that @filepath@ may contain any number of @./@ but may not contain a single @..@ anywhere.
+--
 -- Throws: 'PathParseException'
 --
 parseRelFile :: MonadThrow m