Update README

olzhasar · Jul 21, 2024 · cdf117e · cdf117e
1 parent cea0209
commit cdf117e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -76,7 +76,7 @@ or
 ptw /home/repos/project
 ```
 
-`pytest-watcher` will pass any arguments after `<path>` to the test runner (which is `pytest` by default). For example:
+`pytest-watcher` will pass any arguments (excepted [reserved options](#available-options)) after `<path>` 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
@@ -62,7 +62,7 @@ or
 ptw /home/repos/project
 ```
 
-`pytest-watcher` will pass any arguments after `<path>` to the test runner (which is `pytest` by default). For example:
+`pytest-watcher` will pass any arguments (excepted [reserved options](#available-options)) after `<path>` 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: