Module project
This module does something.
Explain some basics, or the design.
Info:
- Copyright: Copyright (c) [copyright-year]-[copyright-year] [your-name]
- License: MIT, see LICENSE.md.
- Author: [your-name]
Functions
| do_something (what[, force=false]) | Does something. |
Functions
- do_something (what[, force=false])
-
Does something.
It will do what you tell it.
Parameters:
- what string or function the thing that has to be done
- force boolean set to a truthy value to force it. (default false)
Returns:
- boolean success
- nil or string error message on failure
Usage:
local success, err = project.do_something("tell a lie", true) if not success then print("failed at lying; ", err) end