Skip to content

Commit c55d729

Browse files
committed
minor modification in redame and contibuting
1 parent 0f110c9 commit c55d729

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,12 @@ The generated html can be found in docs/build/html. Open up the index.html you f
131131
## Testing
132132
We use GitHub Actions for continuous integration testing. You can check out the current status [here](https://github.com/mathLab/PyGeM/actions/workflows/testing_pr.yml).
133133

134-
To run tests locally (the package `pytest` is required):
134+
To run tests locally, first install the [`test`](#install-with-optional-extras) extra. Then run
135+
135136
```bash
136137
pytest
137138
```
138-
*(Note: The same testing setup is automatically included when installing with `[dev]` extras.)*
139+
*(Note: The same testing setup is automatically included when installing with `dev` extras.)*
139140

140141
## Examples
141142
You can find useful tutorials on how to use the package in the [tutorials](tutorials/README.md) folder.

docs/source/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Common Development Tasks
2121
**Running tests:**
2222

2323
.. code-block:: bash
24-
24+
pip install -e ".[dev]" # or ".[test]" if just running tests
2525
pytest
2626
2727
**Building documentation:**

0 commit comments

Comments
 (0)