branch: elpa/buttercup
commit d8ab09da2f6a4029114ae72e0f196dbd308ea54c
Author: Ola Nilsson <ola.nils...@gmail.com>
Commit: Ola Nilsson <ola.nils...@gmail.com>
Update documentation for the --pattern option in running-tests.md
--pattern matches test descriptions, not filenames.
Fixes #87.
---
docs/running-tests.md | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/docs/running-tests.md b/docs/running-tests.md
index c3ede26..8bebdec 100644
--- a/docs/running-tests.md
+++ b/docs/running-tests.md
@@ -95,9 +95,12 @@ Ran 1 specs, 0 failed, in 0.0 seconds.
```
That’s it. Buttercup’s built-in discover test runner looks for files
-named `test-*.el`, `*-test.el` or `*-tests.el`. You can specify a
-different pattern using the `--pattern` command line argument to the
-`buttercup` program.
+named `test-*.el`, `*-test.el` or `*-tests.el`.
+
+Use the `--pattern PATTERN` option to only Only run tests with names
+matching PATTERN. The `--pattern` option can be used multiple times,
+in which case tests will be run if they match any of the given
+patterns.
You can run this command whichever way you like. Common choices
include a makefile or shell scripts.
