Sort functions alphabetically

Done for consistency and ease of navigation.

Author: tarleb

README.md

@@ -257,39 +257,41 @@ Returns:
 
 ### Path Manipulation Functions
 
-This library includes wrappers around the following functions from the [filepath](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath.html) library for the current platform (POSIX or Windows). All examples below are for [POSIX systems](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html).
+This library includes wrappers around the following functions from
+the [filepath] library for the current platform (POSIX or
+Windows). All examples below are for [POSIX
+systems].
 
-#### take_directory
+#### drop_extension
 
-`take_directory(filepath)`
+`drop_extension(filepath)`
 
-Get the directory name, move up one level.
+Remove last extension, and the `.` preceding it.
 
 ```lua
-takeDirectory("/foo/bar/baz") == "/foo/bar"
-takeDirectory("/foo/bar/baz/") == "/foo/bar/baz"
+dropExtension("/directory/path.ext") == "/directory/path"
 ```
 
 Parameters:
 
 `filepath`
-:   path path
+:   path
 
 Returns:
 
-- The modified filepath.
+- The modified filepath without extension.
 
-This function wraps [System.FilePath.takeDirectory](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeDirectory).
+This function wraps [System.FilePath.dropExtension].
 
-#### take_filename
+#### has_extension
 
-`take_filename(filepath)`
+`has_extensions(filepath)`
 
-Get the file name.
+Does the given filename have an extension?
 
 ```lua
-takeFileName("/directory/file.ext") == "file.ext"
-takeFileName("test/") == ""
+hasExtension("/directory/path.ext") == true
+hasExtension("/directory/path") == false
 ```
 
 Parameters:
@@ -299,20 +301,15 @@ Parameters:
 
 Returns:
 
-- The file name.
-
-This function wraps [System.FilePath.takeFileName](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeFileName).
+- `true` if `filepath` has an extension.
 
-#### take_extensions
+This function wraps [System.FilePath.hasExtension].
 
-`take_extensions(filepath)`
+#### is_absolute
 
-Get all extensions.
+`is_absolute(filepath)`
 
-```lua
-takeExtensions("/directory/path.ext") == ".ext"
-takeExtensions("file.tar.gz") == ".tar.gz
-```
+Is a path absolute? (same as `! is_relative(filepath)`)
 
 Parameters:
 
@@ -321,18 +318,20 @@ Parameters:
 
 Returns:
 
-- String of all extensions.
+- `true` if `filepath` is an absolute path.
 
-This function wraps [System.FilePath.takeExtensions](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeExtensions).
+This function wraps [System.FilePath.isAbsolute].
 
-#### drop_extension
+#### is_relative
 
-`drop_extension(filepath)`
+`ìs_relative(filepath)`
 
-Remove last extension, and the `.` preceding it.
+Is a path relative, or is it fixed to the root?
 
 ```lua
-dropExtension("/directory/path.ext") == "/directory/path"
+isRelative("test/path") == true
+isRelative("/test") == false
+isRelative("/") == false
 ```
 
 Parameters:
@@ -342,31 +341,47 @@ Parameters:
 
 Returns:
 
-- The modified filepath without extension.
+- `true` if `filepath` is a relative path.
 
-This function wraps [System.FilePath.dropExtension](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:dropExtension).
+This function wraps [System.FilePath.isRelative].
 
-#### has_extension
+#### join_path
 
-`has_extensions(filepath)`
+`join_path(filepaths)`
 
-Does the given filename have an extension?
+Join path elements back together by the directory separator.
 
 ```lua
-hasExtension("/directory/path.ext") == true
-hasExtension("/directory/path") == false
+joinPath({"/","directory/","file.ext"}) == "/directory/file.ext"
 ```
 
 Parameters:
 
+`filepaths`
+:   list of paths
+
+Returns:
+
+- The joined path.
+
+This function wraps [System.FilePath.joinPath].
+
+#### normalise
+
+`normalise(filepath)`
+
+Normalise a path. See examples [here][System.FilePath.normalize].
+
+Parameters:
+
 `filepath`
 :   path
 
 Returns:
 
-- `true` if `filepath` has an extension.
+- The normalised path.
 
-This function wraps [System.FilePath.hasExtension](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:hasExtension).
+This function wraps [System.FilePath.normalise].
 
 #### split_directories
 
@@ -389,39 +404,39 @@ Returns:
 
 - A list of all directory paths.
 
-This function wraps [System.FilePath.splitDirectories](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:splitDirectories).
+This function wraps [System.FilePath.splitDirectories].
 
-#### join_path
+#### take_directory
 
-`join_path(filepaths)`
+`take_directory(filepath)`
 
-Join path elements back together by the directory separator.
+Get the directory name, move up one level.
 
 ```lua
-joinPath({"/","directory/","file.ext"}) == "/directory/file.ext"
+takeDirectory("/foo/bar/baz") == "/foo/bar"
+takeDirectory("/foo/bar/baz/") == "/foo/bar/baz"
 ```
 
 Parameters:
 
-`filepaths`
-:   list of paths
+`filepath`
+:   path path
 
 Returns:
 
-- The joined path.
+- The modified filepath.
 
-This function wraps [System.FilePath.joinPath](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:joinPath).
+This function wraps [System.FilePath.takeDirectory].
 
-#### is_relative
+#### take_extensions
 
-`ìs_relative(filepath)`
+`take_extensions(filepath)`
 
-Is a path relative, or is it fixed to the root?
+Get all extensions.
 
 ```lua
-isRelative("test/path") == true
-isRelative("/test") == false
-isRelative("/") == false
+takeExtensions("/directory/path.ext") == ".ext"
+takeExtensions("file.tar.gz") == ".tar.gz
 ```
 
 Parameters:
@@ -431,32 +446,20 @@ Parameters:
 
 Returns:
 
-- `true` if `filepath` is a relative path.
-
-This function wraps [System.FilePath.isRelative](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isRelative).
-
-#### is_absolute
-
-`is_absolute(filepath)`
-
-Is a path absolute? (same as `! is_relative(filepath)`)
-
-Parameters:
-
-`filepath`
-:   path
-
-Returns:
+- String of all extensions.
 
-- `true` if `filepath` is an absolute path.
+This function wraps [System.FilePath.takeExtensions].
 
-This function wraps [System.FilePath.isAbsolute](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isAbsolute).
+#### take_filename
 
-#### normalise
+`take_filename(filepath)`
 
-`normalise(filepath)`
+Get the file name.
 
-Normalise a path. See examples [here](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:normalise).
+```lua
+takeFileName("/directory/file.ext") == "file.ext"
+takeFileName("test/") == ""
+```
 
 Parameters:
 
@@ -465,9 +468,23 @@ Parameters:
 
 Returns:
 
-- The normalised path.
+- The file name.
 
-This function wraps [System.FilePath.normalise](https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:normalise).
+This function wraps [System.FilePath.takeFileName].
+
+
+[filepath]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath.html
+[POSIX systems]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html
+[System.FilePath.dropExtension]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:dropExtension
+[System.FilePath.hasExtension]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:hasExtension
+[System.FilePath.isAbsolute]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isAbsolute
+[System.FilePath.isRelative]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:isRelative
+[System.FilePath.joinPath]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:joinPath
+[System.FilePath.normalise]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:normalise
+[System.FilePath.splitDirectories]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:splitDirectories.
+[System.FilePath.takeDirectory]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeDirectory
+[System.FilePath.takeExtensions]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeExtensions.
+[System.FilePath.takeFileName]: https://hackage.haskell.org/package/filepath-1.4.2.1/docs/System-FilePath-Posix.html#v:takeFileName.
 
 ## License
 

src/Foreign/Lua/Module/System.hs

@@ -35,16 +35,16 @@ module Foreign.Lua.Module.System (
   , with_wd
 
   -- * Path manipulations
-  , take_directory
-  , take_filename
-  , take_extensions
-  , split_directories
-  , has_extension
   , drop_extensions
-  , join_path
-  , is_relative
+  , has_extension
   , is_absolute
+  , is_relative
+  , join_path
   , normalise
+  , split_directories
+  , take_directory
+  , take_extensions
+  , take_filename
   )
 where
 
@@ -234,18 +234,6 @@ with_tmpdir parentDir tmpl callback =
 -- Path manipulations
 --
 
--- | See @System.FilePath.takeDirectory@
-take_directory :: FilePath -> Lua FilePath
-take_directory fp = return (Fp.takeDirectory fp)
-
--- | See @System.FilePath.takeFilename@
-take_filename :: FilePath -> Lua FilePath
-take_filename fp = return (Fp.takeFileName fp)
-
--- | See @System.FilePath.takeExtensions@
-take_extensions :: FilePath -> Lua String
-take_extensions fp = return (Fp.takeExtensions fp)
-
 -- | See @System.FilePath.dropExtension@
 drop_extensions :: FilePath -> Lua String
 drop_extensions fp = return (Fp.dropExtensions fp)
@@ -254,22 +242,34 @@ drop_extensions fp = return (Fp.dropExtensions fp)
 has_extension :: FilePath -> Lua Bool
 has_extension fp = return (Fp.hasExtension fp)
 
--- | See @System.FilePath.splitDirectories@
-split_directories :: FilePath -> Lua [FilePath]
-split_directories fp = return (Fp.splitDirectories fp)
-
--- | See @System.FilePath.joinPath@
-join_path :: [FilePath] -> Lua FilePath
-join_path fps = return (Fp.joinPath fps)
+-- | See @System.FilePath.isAbsolute@
+is_absolute :: FilePath -> Lua Bool
+is_absolute fp = return (Fp.isAbsolute fp)
 
 -- | See @System.FilePath.isRelative@
 is_relative :: FilePath -> Lua Bool
 is_relative fp = return (Fp.isRelative fp)
 
--- | See @System.FilePath.isAbsolute@
-is_absolute :: FilePath -> Lua Bool
-is_absolute fp = return (Fp.isAbsolute fp)
+-- | See @System.FilePath.joinPath@
+join_path :: [FilePath] -> Lua FilePath
+join_path fps = return (Fp.joinPath fps)
 
 -- | See @System.FilePath.normalise@
 normalise :: FilePath -> Lua FilePath
 normalise fp = return (Fp.normalise fp)
+
+-- | See @System.FilePath.splitDirectories@
+split_directories :: FilePath -> Lua [FilePath]
+split_directories fp = return (Fp.splitDirectories fp)
+
+-- | See @System.FilePath.takeDirectory@
+take_directory :: FilePath -> Lua FilePath
+take_directory fp = return (Fp.takeDirectory fp)
+
+-- | See @System.FilePath.takeExtensions@
+take_extensions :: FilePath -> Lua String
+take_extensions fp = return (Fp.takeExtensions fp)
+
+-- | See @System.FilePath.takeFilename@
+take_filename :: FilePath -> Lua FilePath
+take_filename fp = return (Fp.takeFileName fp)