From 556cba2f6d0a85545d9a81baf66dbc848fff848e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 16 Oct 2015 15:19:29 -0400 Subject: clarify which param is which --- src/Propellor/Property/File.hs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/Propellor/Property/File.hs b/src/Propellor/Property/File.hs index 12a3e80a..07ace24b 100644 --- a/src/Propellor/Property/File.hs +++ b/src/Propellor/Property/File.hs @@ -97,8 +97,12 @@ dirExists :: FilePath -> Property NoInfo dirExists d = check (not <$> doesDirectoryExist d) $ property (d ++ " exists") $ makeChange $ createDirectoryIfMissing True d --- | Creates or atomically updates a symbolic link. Does not overwrite regular --- files or directories. +-- | Creates or atomically updates a symbolic link. +-- +-- The first parameter is what the link should point to. +-- +-- The second parameter is the name of the symbolic link to create. +-- Does not overwrite regular files or directories. isSymlinkedTo :: FilePath -> FilePath -> Property NoInfo link `isSymlinkedTo` target = property desc $ go =<< (liftIO $ tryIO $ getSymbolicLinkStatus link) -- cgit v1.2.3