Fix incorrect comment about removeDirectoryRecursive and symlinks

haskell · Jun 6, 2014 · db88005 · db88005
1 parent 0c64d54
commit db88005
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/System/Directory.hs b/System/Directory.hs
@@ -460,9 +460,10 @@ removeDirectory path =
 
 #endif
 
--- | @'removeDirectoryRecursive' dir@  removes an existing directory /dir/
--- together with its content and all subdirectories. Be careful,
--- if the directory contains symlinks, the function will follow them.
+-- | @'removeDirectoryRecursive' dir@ removes an existing directory
+-- /dir/ together with its content and all subdirectories. If the
+-- directory contains symlinks this function removes but does not
+-- follow them.
 removeDirectoryRecursive :: FilePath -> IO ()
 removeDirectoryRecursive startLoc = do
   cont <- getDirectoryContents startLoc