Skip to content

Commit

Permalink
Small documentation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
hasufell committed May 30, 2016
1 parent abf043b commit 82ea75c
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/HPath/Internal.hs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import Data.Data

-- | 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@
-- 2. with trailing path separator: @foo\/@, @\/foo\/bar\/@
Expand All @@ -22,23 +22,23 @@ import Data.Data
data Path b = MkPath ByteString
deriving (Typeable)

-- | String equality.
-- | ByteString equality.
--
-- The following property holds:
--
-- @show x == show y ≡ x == y@
instance Eq (Path b) where
(==) (MkPath x) (MkPath y) = x == y

-- | String ordering.
-- | ByteString ordering.
--
-- The following property holds:
--
-- @show x \`compare\` show y ≡ x \`compare\` y@
instance Ord (Path b) where
compare (MkPath x) (MkPath y) = compare x y

-- | Same as 'Path.toFilePath'.
-- | Same as 'HPath.toFilePath'.
--
-- The following property holds:
--
Expand Down

0 comments on commit 82ea75c

Please sign in to comment.