hasufell/hpath
1
1
Fork 0
Code Issues 8 Pull Requests Releases Wiki Activity

Small documentation fix

Browse Source
This commit is contained in:
Julian Ospald 2016-05-30 17:16:24 +02:00
parent abf043be14
commit 82ea75cc88
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/HPath/Internal.hs
View File

@ -12,7 +12,7 @@ import Data.Data
-- | Path of some base and type. -- | Path of some base and type.
-- --
-- Internally is a string. The string can be of two formats only: -- Internally is a ByteString. The ByteString can be of two formats only:
-- --
-- 1. without trailing path separator: @file.txt@, @foo\/bar.txt@, @\/foo\/bar.txt@ -- 1. without trailing path separator: @file.txt@, @foo\/bar.txt@, @\/foo\/bar.txt@
-- 2. with trailing path separator: @foo\/@, @\/foo\/bar\/@ -- 2. with trailing path separator: @foo\/@, @\/foo\/bar\/@
@ -22,7 +22,7 @@ import Data.Data
data Path b = MkPath ByteString data Path b = MkPath ByteString
deriving (Typeable) deriving (Typeable)
-- | String equality. -- | ByteString equality.
-- --
-- The following property holds: -- The following property holds:
-- --
@ -30,7 +30,7 @@ data Path b = MkPath ByteString
instance Eq (Path b) where instance Eq (Path b) where
(==) (MkPath x) (MkPath y) = x == y (==) (MkPath x) (MkPath y) = x == y
-- | String ordering. -- | ByteString ordering.
-- --
-- The following property holds: -- The following property holds:
-- --
@ -38,7 +38,7 @@ instance Eq (Path b) where
instance Ord (Path b) where instance Ord (Path b) where
compare (MkPath x) (MkPath y) = compare x y compare (MkPath x) (MkPath y) = compare x y
-- | Same as 'Path.toFilePath'. -- | Same as 'HPath.toFilePath'.
-- --
-- The following property holds: -- The following property holds:
-- --