Merge pull request #397 from jamestalmage/document-skipped-assertions

Document skippable assertions.
avajs · Jan 1, 2016 · f696271 · f696271
2 parents f8701d5 + 879e036
commit f696271
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -566,6 +566,17 @@ Assert that `function` doesn't throw an `error` or `promise` resolves.
 
 Assert that `error` is falsy.
 
+## Skipping Assertions
+
+Any assertion can be skipped using the `skip` modifier. Skipped assertions are still counted, so there is no need to change your planned assertion count.
+
+```js
+test(t => {
+  t.plan(2);
+  t.skip.is(foo(), 5); // no need to change your plan count when skipping.
+  t.is(1, 1);
+});
+```
 
 ## Enhanced asserts