#49, move the docs from </> to combine, so its all in one place
authorNeil Mitchell <ndmitchell@gmail.com>
Tue, 22 Dec 2015 08:07:21 +0000 (08:07 +0000)
committerNeil Mitchell <ndmitchell@gmail.com>
Tue, 22 Dec 2015 08:07:21 +0000 (08:07 +0000)
System/FilePath/Internal.hs

index 1e95d17..c67b0eb 100644 (file)
@@ -606,6 +606,8 @@ replaceDirectory x dir = combineAlways dir (takeFileName x)
 -- | Combine two paths, if the second path starts with a path separator or a
 --   drive letter, then it returns the second.
 --
+-- > Posix:   "/directory" </> "file.ext" == "/directory/file.ext"
+-- > Windows: "/directory" </> "file.ext" == "/directory\\file.ext"
 -- > Valid x => combine (takeDirectory x) (takeFileName x) `equalFilePath` x
 --
 --   Combined:
@@ -654,9 +656,6 @@ combineAlways a b | null a = b
 
 
 -- | Join two values with a path separator. For examples and caveats see the equivalent function 'combine'.
---
--- > Posix:   "/directory" </> "file.ext" == "/directory/file.ext"
--- > Windows: "/directory" </> "file.ext" == "/directory\\file.ext"
 (</>) :: FilePath -> FilePath -> FilePath
 (</>) = combine