docs: fix typos (#1813)

main
lowercase00 2 years ago committed by GitHub
parent 3d840a79ad
commit eef6dbbb3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -15,32 +15,32 @@ Bear in mind that you need to have all those versions installed in your local en
### Testing with Pytest directly ### Testing with Pytest directly
For a faster and simpler testing alternative you can just run `pytest` directlyL For a faster and simpler testing alternative you can just run `pytest` directly.
```sh ```sh
pytest . pytest .
``` ```
It should automatically pickup the `tests` directory and run the test suite. It should automatically pickup the `tests` directory and run the test suite.
Bear in mind that some tests will be skipped in a local environment - make sure to look at what tests are being skipped. Bear in mind that some tests may be be skipped in your local environment - make sure to look at which tests are being skipped.
### Skipped Tests ### Skipped Tests
Apart from skipped tests related to interpreter (eg `PyPy`) or operational systems, slow tests are also skipped by default, but are ran in the GitHub CI/CD workflow. Apart from skipped tests related to the interpreter (eg. `PyPy`) or operational systems, slow tests are also skipped by default, but are ran in the GitHub CI/CD workflow.
To include slow tests in your local environment, use the `RUN_SLOW_TESTS_TOO=1` environment variable: To include slow tests in your local environment, use the `RUN_SLOW_TESTS_TOO=1` environment variable:
```sh ```sh
RUN_SLOW_TESTS_TOO=1 pytest . RUN_SLOW_TESTS_TOO=1 pytest .
``` ```
If you want to analyze the coverage reports, you can use the `--cov` argument to `pytest`: If you want to analyze the coverage reports, you can use the `--cov` argument to `pytest`. By adding `--cov-report`, you also have some flexibility in terms of the report output format:
```sh ```sh
RUN_SLOW_TESTS_TOO=1 pytest --cov=./ --cov-report={{report_format}} --durations=5 RUN_SLOW_TESTS_TOO=1 pytest --cov=./ --cov-report={{report_format}} --durations=5
``` ```
Where you replace thte `report_format` fot the desired formatting ()`term` / `html` / `xml`). Where you replace the `report_format` by the desired format (`term` / `html` / `xml`).
### Using Vagrant ### Using Vagrant

Loading…
Cancel
Save