docs: reference testing configuration in hatch test help#2235
Open
mvanhorn wants to merge 3 commits intopypa:masterfrom
Open
docs: reference testing configuration in hatch test help#2235mvanhorn wants to merge 3 commits intopypa:masterfrom
mvanhorn wants to merge 3 commits intopypa:masterfrom
Conversation
Add a note to the hatch test docstring pointing users to --show and the testing configuration docs. Without this, dependency conflicts from built-in defaults are confusing because the help output gives no indication that default dependencies exist. Fixes pypa#2202
cjames23
reviewed
Apr 15, 2026
| The test environment comes with default dependencies (pytest, coverage, etc.). Use the | ||
| `-s`/`--show` option to see the full resolved configuration for each environment. | ||
| To customize dependencies or other settings, see the | ||
| [testing configuration](https://hatch.pypa.io/latest/config/internal/testing/). |
Member
There was a problem hiding this comment.
Do not use markdown in help text, just use the direct URL.
Addresses review from @cjames23: markdown syntax doesn't render in CLI help output, so the `[testing configuration](...)` link appeared as-is to users. Use the plain URL on its own line.
Author
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
2 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.
Summary
Adds a note to the
hatch testcommand help text pointing users to--showand the testing configuration docs page. Right now, the help output gives no indication that default dependencies (pytest, coverage, pytest-rerunfailures) exist, leading to confusing resolution errors when users add conflicting versions via extra-dependencies.Changes
src/hatch/cli/test/__init__.py: Appended a paragraph to the command docstring mentioning the--showflag and linking to the testing configuration docs.Fixes #2202
This contribution was developed with AI assistance (Claude Code).