summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorolivia <olivia@fastmail.com>2018-05-22 22:27:51 +0200
committerolivia <olivia@fastmail.com>2018-05-22 22:27:51 +0200
commit54f58cd726eeb7acc2ebb1491729444aab367e87 (patch)
tree11899cada3689ff9dbbff9a4bbb719e99fb64b88
parent4eca18050f21b3bc69477118845903ec61283d4f (diff)
update docs
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 563ec94..4ddaae5 100644
--- a/README.md
+++ b/README.md
@@ -30,10 +30,10 @@ pub fn exec() {
Each exercise file is supposed to have one `exec` function which gets called by the `main.rs` file.
This function, in turn, calls all individual test functions.
-The tests themselves can generally be structured in whatever way is desired. Two macros are provided
-for convenience. The `verify!` macro is essentially a specialized `assert_eq!`, but it doesn't panic
+The tests themselves can generally be structured in whatever way is desired, there doesn't have to be a "tests" module, for example. Two macros are provided
+for convenience. The `verify` helper function is essentially a specialized `assert_eq!`, but it doesn't panic
if the values mismatch, instead it prints out a helpful error message and keeps going. The
-`verify_easy!` macro is designed as a drop-in replacement for the `verify!` macro for if the learner needs help solving the exercise. It prints the expected value, too.
+`verify_easy` function is designed as a drop-in replacement for the `verify` function for if the learner needs help solving the exercise. It prints the expected value, too.
This is roughly what the console output for a simple exercise looks right now: