Improve tox usage documentation - #1088
Open
Czaki wants to merge 7 commits into
Open
Conversation
github-actions
Bot
added
the
documentation
brisvag
approved these changes
Aug 7, 2026
brisvag
left a comment
brisvag
left a comment
Contributor
There was a problem hiding this comment.
Love this, thanks! Added some copy edit comments.
Co-authored-by: Lorenzo Gaifas <brisvag@gmail.com>
willingc
reviewed
Aug 7, 2026
| UV_CONSTRAINT=resources/constraints/constraints_py313.txt tox -e py313-pyqt6 | ||
| ``` | ||
|
|
||
| Constraint usage guarantees the same version of dependencies as in the CI environment. It usually isn’t needed, but it sometimes happens that the newest version of some dependency is not compatible with the napari test suite, and it is useful to have a way to run tests with the same versions of dependencies as in the CI environment. |
Contributor
There was a problem hiding this comment.
Suggested change
| Constraint usage guarantees the same version of dependencies as in the CI environment. It usually isn’t needed, but it sometimes happens that the newest version of some dependency is not compatible with the napari test suite, and it is useful to have a way to run tests with the same versions of dependencies as in the CI environment. | |
| Constraint usage guarantees the same version of dependencies as in the CI environment where versions are specified down to the SHA commits of the dependencies. | |
| While it usually isn’t needed to run this locally, running tests with the constraint file ensures that tests run with the exact same versions of dependencies as in napari's CI environment. |
Contributor
Author
There was a problem hiding this comment.
It is not specified to SHA of commit but to version on PyPI.
TimMonko
pushed a commit
to napari/napari
that referenced
this pull request
Aug 10, 2026
# References and relevant issues required for napari/docs#1088 # Description When I was doing #8367, I did not spot that fully removing of `[tool.coverage.paths]` from `pyproject.toml` will make it hard to generate a local coverage report when running tests using Tox. This PR restores this option. On the other hand, no one reported this problem...
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
References and relevant issues
Depends on napari/napari#9368 (if we want a section about the coverage)
Description
Improve part of the documentation about the usage of
toxfor testing the napari.Add details about
Plus some minor fixes in tox commands.
The documentation might be simplified if napari/napari#9270 is ended and merged.