Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this PR, we now have three possible tox environments: the default (run pytest),
fix
(runs black and isort commands that editsrc/
and some ofdocs
), andcheck
(just check those directories and raise error).Then additionally made changes to
ci.yml
:check
job, which just runs thecheck
tox environment.pip install -e .[dev]
during set up of tox (because tox will install all requirements into its owncheck
job now requires all oftests
,prevent_docs_absolute_links
, andcheck
environments)Thus our CI should be slightly faster (as we're no longer installing unnecessary packages and only running black+isort+flake8 with one OS / python version, instead of all)
I think that by editing
envlist
at the top of thetox.ini
, we can make it so the default tox action is to run the test with a single python version and also runfix
, do we want that?Finally, CONTRIBUTING still needs to be updated. if this all looks good to you, I can go ahead and update it to reflect these changes.