hasufell/hsfm
1
1
Fork 0
Code Issues 33 Pull Requests Releases Wiki Activity

LIB: improve documentation in readWith

Browse Source
This commit is contained in:
Julian Ospald 2016-03-31 02:29:32 +02:00
parent a2e6ced69a
commit 91b2dc9e4b
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/HSFM/FileSystem/FileType.hs
View File

@ -442,6 +442,10 @@ instance Ord (AnchoredFile FileInfo) where
-- |Reads a file or directory Path into an `AnchoredFile`, filling the free -- |Reads a file or directory Path into an `AnchoredFile`, filling the free
-- variables via the given function. -- variables via the given function.
-- The dirname of the given path will be canonicalized using `realpath`, so the
-- anchor of `AnchoredFile` is always canonicalized.
--
-- Exceptions: when `canonicalizePath` fails, throws IOError
readWith :: (Path Abs -> IO a) -- ^ function that fills the free readWith :: (Path Abs -> IO a) -- ^ function that fills the free
-- a variable -- a variable
-> Path Abs -- ^ Path to read -> Path Abs -- ^ Path to read
@ -450,7 +454,7 @@ readWith ff p = do
let fn = P.basename p let fn = P.basename p
bd = P.dirname p bd = P.dirname p
p' = P.toFilePath p p' = P.toFilePath p
bd' <- P.canonicalizePath bd -- TODO: this will cause a dialog to pop up on error bd' <- P.canonicalizePath bd
handleDT bd' fn $ do handleDT bd' fn $ do
fs <- PF.getSymbolicLinkStatus p' fs <- PF.getSymbolicLinkStatus p'
fv <- ff p fv <- ff p