Improve documentation

This commit is contained in:
Julian Ospald 2020-01-20 19:46:10 +01:00
parent 7b66379d49
commit 607e67378c
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
2 changed files with 11 additions and 7 deletions

View File

@ -31,7 +31,7 @@ module HPath
-- * PatternSynonyms/ViewPatterns
,pattern Path
#endif
-- * Path Parsing
-- * Path Construction
,parseAbs
,parseRel
,parseAny

View File

@ -10,15 +10,19 @@ import Control.DeepSeq (NFData (..))
import Data.ByteString (ByteString)
import Data.Data
-- | Path of some base and type.
-- | The main Path type.
--
-- Internally is a ByteString. The ByteString can be of two formats only:
-- The type variable 'b' is either:
--
-- 1. without trailing path separator: @file.txt@, @foo\/bar.txt@, @\/foo\/bar.txt@
-- 2. with trailing path separator: @foo\/@, @\/foo\/bar\/@
-- * Abs -- absolute path
-- * Rel -- relative path
--
-- There are no duplicate
-- path separators @\/\/@, no @..@, no @.\/@, no @~\/@, etc.
-- Internally is a ByteString. The path is guaranteed to
-- be normalised and contain no trailing Path separators,
-- except for the '/' root path.
--
-- There are no duplicate path separators
-- @\/\/@, no @..@, no @.\/@, no @~\/@, etc.
data Path b = MkPath ByteString
deriving (Typeable)