Skip to content

Commit

Permalink
Make installation instructions more consistent
Browse files Browse the repository at this point in the history
If people who want to run the tests didn't install the test extra,
they can still install that extra. This simplifies the instructions
accordingly. test-requirements.txt is still mentioned near the
beginning in case people want to look at it to see dependencies.
But the changed code is the only place where the instructions had
still said to do anything with those files.

A possible disadvantage of this change is that in the rare case
that someone following those instructions to run the tests locally
didn't do an editable installation, then installing with the extra
shouldn't be done editably either. But this doesn't seem like a
likely problem, and the new text has an example command with -e to
clarify the kind of command whose effect is augmented here.

Because of that subtlety, it is not obvious that this change is
really justified for purposes of clarity. However, this also helps
prepare for a time when test-requirements.txt won't exist anymore,
as may happen when the project definition is made fully declarative
(see discussion in comments in #1716).
  • Loading branch information
EliahKagan committed Mar 12, 2024
1 parent 2775b60 commit a6a2a37
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,8 @@ Ensure testing libraries are installed. This is taken care of already if you ins
pip install -e ".[test]"
```

Otherwise, you can run:

```sh
pip install -r test-requirements.txt
```
If you had installed with a command like `pip install -e .` instead, you can still run
the above command to add the testing dependencies.

#### Test commands

Expand Down

0 comments on commit a6a2a37

Please sign in to comment.