Clarify what limitations the RelX parsers have.

Signed-off-by: Magnus Therning <magnus@therning.org>
2016-01-07 16:15:06 +01:00
parent 28c4f7fe21
commit b5cff315a1
2 changed files with 9 additions and 0 deletions
--- a/src/Path.hs
+++ b/src/Path.hs
@@ -93,6 +93,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
@@ -125,6 +127,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