diff --git a/docs/GlobalAPI.md b/docs/GlobalAPI.md index 2c26605f422d..d01f975884b8 100644 --- a/docs/GlobalAPI.md +++ b/docs/GlobalAPI.md @@ -528,7 +528,7 @@ test.each` ### `test.only(name, fn, timeout)` -Also under the aliases: `it.only(name, fn, timeout)` or `fit(name, fn, timeout)` +Also under the aliases: `ftest(name, fn, timeout)`, `it.only(name, fn, timeout)`, and `fit(name, fn, timeout)` When you are debugging a large test file, you will often only want to run a subset of tests. You can use `.only` to specify which tests are the only ones you want to run in that test file. @@ -552,7 +552,7 @@ Usually you wouldn't check code using `test.only` into source control - you woul ### `test.only.each(table)(name, fn)` -Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, `` it.only.each`table`(name, fn) `` and `` fit.each`table`(name, fn) `` +Also under the aliases: `ftest.each(table)(name, fn)`, `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, `` ftest.each`table`(name, fn) ``, `` it.only.each`table`(name, fn) `` and `` fit.each`table`(name, fn) `` Use `test.only.each` if you want to only run specific tests with different test data. @@ -593,7 +593,7 @@ test('will not be ran', () => { ### `test.skip(name, fn)` -Also under the aliases: `it.skip(name, fn)` or `xit(name, fn)` or `xtest(name, fn)` +Also under the aliases: `it.skip(name, fn)`, `xit(name, fn)`, and `xtest(name, fn)` When you are maintaining a large codebase, you may sometimes find a test that is temporarily broken for some reason. If you want to skip running this test, but you don't want to delete this code, you can use `test.skip` to specify some tests to skip. @@ -656,6 +656,8 @@ test('will be ran', () => { ### `test.todo(name)` +Also under the alias: `it.todo(name)` + Use `test.todo` when you are planning on writing tests. These tests will be highlighted in the summary output at the end so you know how many tests you still need todo. _Note_: If you supply a test callback function then the `test.todo` will throw an error. If you have already implemented the test and it is broken and you do not want it to run, then use `test.skip` instead.