[commit: packages/filepath] master: Improve the module description (28b7f1b)

git at git.haskell.org git at git.haskell.org
Thu Mar 19 11:33:41 UTC 2015


Repository : ssh://git@git.haskell.org/filepath

On branch  : master
Link       : http://git.haskell.org/packages/filepath.git/commitdiff/28b7f1bbdee5f71b47e6320727d1c3f809f20bb0

>---------------------------------------------------------------

commit 28b7f1bbdee5f71b47e6320727d1c3f809f20bb0
Author: Neil Mitchell <ndmitchell at gmail.com>
Date:   Sun Oct 19 14:10:44 2014 +0100

    Improve the module description


>---------------------------------------------------------------

28b7f1bbdee5f71b47e6320727d1c3f809f20bb0
 filepath.cabal | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/filepath.cabal b/filepath.cabal
index c93a78e..1d093c5 100644
--- a/filepath.cabal
+++ b/filepath.cabal
@@ -14,12 +14,15 @@ synopsis:       Library for manipulating FilePaths in a cross platform way.
 cabal-version:  >=1.10
 tested-with:    GHC==7.6.3, GHC==7.6.2, GHC==7.6.1, GHC==7.4.2, GHC==7.4.1, GHC==7.2.2, GHC==7.2.1, GHC==7.0.4, GHC==7.0.3, GHC==7.0.2, GHC==7.0.1, GHC==6.12.3
 description:
-    A library for 'FilePath' manipulations, using Posix or Windows filepaths
-    depending on the platform.
+    This package provides functionality for manipulating @FilePath@ values, and is shipped with both <https://www.haskell.org/ghc/ GHC> and the <https://www.haskell.org/platform/ Haskell Platform>. It provides three modules:
     .
-    Both "System.FilePath.Posix" and "System.FilePath.Windows" provide
-    the same interface. See either for examples and a list of the
-    available functions.
+    * "System.FilePath.Posix" manipulates POSIX\/Linux style @FilePath@ values (with @\/@ as the path separator).
+    .
+    * "System.FilePath.Windows" manipulates Windows style @FilePath@ values (with either @\\@ or @\/@ as the path separator, and deals with drives).
+    .
+    * "System.FilePath" is an alias for the module appropriate to your platform.
+    .
+    All three modules provide the same API, and the same documentation (calling out differences in the different variants).
 
 extra-source-files:
     System/FilePath/Internal.hs



More information about the ghc-commits mailing list