search

luc-tielen / lua-quickcheck

Property based testing in Lua, inspired by the original QuickCheck.
MIT License
37 stars 1 forks source link

Add documentation #15

Closed luc-tielen closed 8 years ago

luc-tielen commented 8 years ago

Currently the documentation for all functions is in an unofficial format, sometimes incomplete or missing. This should be fixed by one of the options suggested in http://lua-users.org/wiki/DocumentingLuaCode to make it easier for users to use this tool.

luc-tielen commented 8 years ago

Updated documentation is present as of v0.2-2 (by making use of LDoc). Can be generated with make docs and then viewed in the browser.