Skip to content

Commit

Permalink
Update documentation and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aw committed Mar 29, 2015
1 parent 4b671e9 commit 519ebcf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## 0.5.0 (2015-03-29)

* Assertions now return T or NIL, for passed or failed tests
* Nothing is printed to the display if (report) is not called
* All test results are accumulated in *Results global variable

## 0.4.1 (2015-03-28)

* Documentation update
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,20 @@ There are 5 types currently defined:
* Colours and bold text are only displayed if your terminal supports it, and if your system has the `tput` command.
* The `(assert-includes)` function uses [sub?](http://software-lab.de/doc/refS.html#sub?) to find a substring in a string or list.
* The `(assert-throws)` function requires the `(throw)` to be [quoted](http://software-lab.de/doc/refQ.html#quote).
* Assertions return `T` if the test passed, and `NIL` if the test failed
* Results of all tests are accumulated in the `*Results` global variable

### Test results

The `*Results` global variable is a list of lists, which will have one of two formats:

((NIL 1 "should be NIL" NIL T) (T 2 "should be NIL"))

1. `NIL` or `T` in the `(car)` if the test failed or passed, respectively
2. Number indicating the counter for the test
3. Message of the test
4. Expected result (only when the test failed)
5. Actual result (only when the test failed)

# Examples

Expand Down

0 comments on commit 519ebcf

Please sign in to comment.