diff --git a/README.md b/README.md index 21ed645..7fdd50b 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ or ptw /home/repos/project ``` -`pytest-watcher` will pass any arguments after `` to the test runner (which is `pytest` by default). For example: +`pytest-watcher` will pass any arguments (excepted [reserved options](#available-options)) after `` to the test runner (which is `pytest` by default). For example: ```sh ptw . -x --lf --nf @@ -88,6 +88,17 @@ will call `pytest` with the following arguments: pytest -x --lf --nf ``` +### Available options + +The following options are reserved for `pytest-watcher` and will not be passed to the test runner: + +- `--runner` - Specify an alternative test runner +- `--patterns` - Specify file patterns to watch +- `--ignore-patterns` - Specify file patterns to ignore +- `--now` - Run tests immediately after starting the watcher +- `--delay` - Specify the delay before running tests +- `--clear` - Clear the terminal screen before each test run + ### Using a different test runner You can specify an alternative test runner using the `--runner` flag: diff --git a/docs/index.md b/docs/index.md index 5e3eb50..7f8ca36 100644 --- a/docs/index.md +++ b/docs/index.md @@ -62,7 +62,7 @@ or ptw /home/repos/project ``` -`pytest-watcher` will pass any arguments after `` to the test runner (which is `pytest` by default). For example: +`pytest-watcher` will pass any arguments (excepted [reserved options](#available-options)) after `` to the test runner (which is `pytest` by default). For example: ```sh ptw . -x --lf --nf @@ -74,6 +74,17 @@ will call `pytest` with the following arguments: pytest -x --lf --nf ``` +### Available options + +The following options are reserved for `pytest-watcher` and will not be passed to the test runner: + +- `--runner` - Specify an alternative test runner +- `--patterns` - Specify file patterns to watch +- `--ignore-patterns` - Specify file patterns to ignore +- `--now` - Run tests immediately after starting the watcher +- `--delay` - Specify the delay before running tests +- `--clear` - Clear the terminal screen before each test run + ### Using a different test runner You can specify an alternative test runner using the `--runner` flag: