hslua-module-system 1.1.0 → 1.1.0.1

raw patch · 3 files changed

+16/−9 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +6/−0
• hslua-module-system.cabal +1/−1
• src/HsLua/Module/System.hs +9/−8

@@ -2,6 +2,12 @@  `hslua-module-system` uses [PVP Versioning][]. +## hslua-module-system-1.1.0.1++Released 2023-03-26.++-   Improve doc strings.+ ## hslua-module-system-1.1.0  -   Update to hslua-2.3; this includes the addition of type

@@ -1,6 +1,6 @@ cabal-version:       2.2 name:                hslua-module-system-version:             1.1.0+version:             1.1.0.1 synopsis:            Lua module wrapper around Haskell's System module.  description:         Provides access to system information and

@@ -161,8 +161,7 @@   #? T.unlines      [ "Returns the number of picoseconds CPU time used by the current"      , "program. The precision of this result may vary in different"-     , "versions and on different platforms. See also the field"-     , "`cputime_precision`."+     , "versions and on different platforms."      ]  -- | Retrieve the entire environment@@ -170,8 +169,8 @@ env = defun "env"   ### ioToLua Env.getEnvironment   =#> functionResult (pushKeyValuePairs pushString pushString) "table"-        "A table mapping environment variable names to their value"-  #? "Retrieves the entire environment."+        "A table mapping environment variable names to their value."+  #? "Retrieves the entire environment as a string-indexed table."  -- | Return the current working directory as an absolute path. getwd :: LuaError e => DocumentedFunction e@@ -298,9 +297,9 @@               Lua.liftIO (Directory.setCurrentDirectory fp)               callback `invokeWithFilePath` fp))   <#> filepathParam "directory"-        "Directory in which the given `callback` should be executed."+        "Directory in which the given `callback` should be executed"   <#> parameter peekCallback "function" "callback"-        "Action to execute in the given directory."+        "Action to execute in the given directory"   =?> "The results of the call to `callback`."   #? T.unwords      [ "Run an action within a different directory. This function will"@@ -358,8 +357,10 @@         ("Function which takes the name of the temporary directory as "          `T.append` "its first argument.")   =?> "The results of the call to `callback`."-  #? ("Create and use a temporary directory inside the given directory."-      `T.append` "The directory is deleted after use.")+  #? T.unlines+     [ "Create and use a temporary directory inside the given directory."+     , "The directory is deleted after the callback returns."+     ]   where     peekParentDir idx = do       args <- liftLua gettop