Skip to content

Commit

Permalink
some minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep committed Sep 2, 2024
1 parent 3ac0a27 commit 2f5e39c
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions {{cookiecutter.project_name}}/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,14 @@ you need additional python packages to [run tests](#writing-tests) and [build th
The easiest way is to get familiar with [hatch environments][], with which these tasks are simply:

```bash
hatch test
hatch run docs:build
hatch test # defined in the table [tool.hatch.envs.hatch-test] in pyproject.toml
hatch run docs:build # defined in the table [tool.hatch.envs.docs]
```

If you prefer managing environments manually, you can use `pip`:

```bash
cd {{ cookiecutter.project_name }}
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,test,doc]"
```

Expand Down Expand Up @@ -73,7 +71,7 @@ Consider enabling this option for [ruff][ruff-editors] and [prettier][prettier-e

## Writing tests

This package uses the [pytest][] for automated testing.
This package uses [pytest][] for automated testing.
Please write {doc}`scanpy:dev/testing` for every function added to the package.

Most IDEs integrate with pytest and provide a GUI to run tests.
Expand Down

0 comments on commit 2f5e39c

Please sign in to comment.