Browse Source

Improve documentation

travis
Julian Ospald 2 years ago
parent
commit
607e67378c
No known key found for this signature in database GPG Key ID: 511B62C09D50CD28
2 changed files with 11 additions and 1 deletions
  1. +1
    -1
      hpath/src/HPath.hs
  2. +10
    -0
      hpath/src/HPath/Internal.hs

+ 1
- 1
hpath/src/HPath.hs View File

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


+ 10
- 0
hpath/src/HPath/Internal.hs View File

@@ -10,15 +10,19 @@ import Control.DeepSeq (NFData (..))
import Data.ByteString (ByteString)
import Data.Data

-- | The main Path type.
--
-- The type variable 'b' is either:
--
-- * Abs -- absolute path
-- * Rel -- relative path
--
-- 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)



Loading…
Cancel
Save