Skip to content

Commit 75fde66

Browse files
committed
docs(pytest plugin) Document new fixtures
1 parent 50b2ccc commit 75fde66

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/pytest-plugin.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This pytest plugin works by providing {ref}`pytest fixtures <pytest:fixtures-api
3737

3838
## Recommended Fixtures
3939

40-
When the plugin is enabled and `pytest` is run, these fixtures are automatically used:
40+
When the plugin is enabled and `pytest` is run, these overridable fixtures are automatically used:
4141

4242
- Create temporary test directories for:
4343
- `/home/` ({func}`home_path`)
@@ -50,6 +50,11 @@ When the plugin is enabled and `pytest` is run, these fixtures are automatically
5050
- Set default VCS configurations:
5151
- Use {func}`hgconfig` for [`HGRCPATH`] via {func}`set_hgconfig`
5252
- Use {func}`gitconfig` for [`GIT_CONFIG`] via {func}`set_gitconfig`
53+
- Set default commit names and emails:
54+
- Name: {func}`vcs_name`
55+
- Email: {func}`vcs_email`
56+
- User (e.g. _user <email@tld>_): {func}`vcs_user`
57+
- For git only: {func}`git_commit_envvars`
5358

5459
These ensure that repositories can be cloned and created without unnecessary warnings.
5560

0 commit comments

Comments
 (0)