search

lunarmodules / luassert

Assertion library for Lua
MIT License
202 stars 76 forks source link

Complete, exhaustive reference? #168

Closed rulatir closed 4 years ago

rulatir commented 4 years ago

The examples in the readme and on the homepage are far from exhaustive. Where can I find a complete, exhaustive reference of all functions/assertions/matchers/whatever provided by luassert? Specific case: trying to use assert.are.near(), not knowing at which position the error/epsilon parameter goes, searching high and low, not finding the answer anywhere. Principally refusing to inspect source code because having to inspect source code in order to learn API is wrong.

Tieske commented 4 years ago

the best reference is Busted docs, or alternatively the source/test code.

ajacksified commented 4 years ago

Principally refusing to inspect source code because having to inspect source code in order to learn API is wrong

I agree! Feel free to make a pull request to this open-source project that we work on on our free time to add the documentation you find to be missing. :)