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

Small documentation improvements

This commit is contained in:
Julian Ospald 2016-05-22 13:41:39 +02:00
parent 620550dab4
commit 47dd729e8a
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/HPath/IO/Errors.hs
View File

@ -218,7 +218,7 @@ sameFile fp1 fp2 =
-- source directory with all device+file IDs of the parent directories -- source directory with all device+file IDs of the parent directories
-- of the destination. -- of the destination.
throwDestinationInSource :: Path Abs -- ^ source dir throwDestinationInSource :: Path Abs -- ^ source dir
-> Path Abs -- ^ full destination, `dirname dest` -> Path Abs -- ^ full destination, @dirname dest@
-- must exist -- must exist
-> IO () -> IO ()
throwDestinationInSource source dest = do throwDestinationInSource source dest = do

4
src/System/Posix/FD.hs
View File

@ -60,13 +60,13 @@ open_ str how optional_flags maybe_mode = do
-- |Open and optionally create this file. See 'System.Posix.Files' -- |Open and optionally create this file. See 'System.Posix.Files'
-- for information on how to use the 'FileMode' type. -- for information on how to use the 'FileMode' type.
-- --
-- Note that passing `Just x` as the 4th argument triggers the -- Note that passing @Just x@ as the 4th argument triggers the
-- `oCreat` status flag, which must be set when you pass in `oExcl` -- `oCreat` status flag, which must be set when you pass in `oExcl`
-- to the status flags. Also see the manpage for @open(2)@. -- to the status flags. Also see the manpage for @open(2)@.
openFd :: RawFilePath openFd :: RawFilePath
-> Posix.OpenMode -> Posix.OpenMode
-> [Flags] -- ^ status flags of @open(2)@ -> [Flags] -- ^ status flags of @open(2)@
-> Maybe Posix.FileMode -- ^ Just x => creates the file with the given modes, Nothing => the file must exist. -> Maybe Posix.FileMode -- ^ @Just x@ => creates the file with the given modes, Nothing => the file must exist.
-> IO Posix.Fd -> IO Posix.Fd
openFd name how optional_flags maybe_mode = openFd name how optional_flags maybe_mode =
withFilePath name $ \str -> withFilePath name $ \str ->