Skip to content

Commit e38e1f7

Browse files
committed
docs: Improve consistency and clarity in fixture documentation
1 parent ddf3f1e commit e38e1f7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/pytest-plugin.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@ 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 overridable fixtures are automatically used:
40+
When the plugin is enabled and `pytest` is run, the following overridable fixtures are automatically used:
4141

4242
- Create temporary test directories for:
4343
- `/home/` ({func}`home_path`)
4444
- `/home/${user}` ({func}`user_path`)
45-
- Set the home directory:
45+
- Set up the home directory:
4646
- Patch `$HOME` to point to {func}`user_path` using {func}`set_home`
4747
- Create configuration files:
4848
- `.gitconfig` via {func}`gitconfig`
4949
- `.hgrc` via {func}`hgconfig`
50-
- Set default VCS configurations:
50+
- Configure default VCS settings:
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:
53+
- Set default commit information:
5454
- Name: {func}`vcs_name`
5555
- Email: {func}`vcs_email`
56-
- User (e.g. _`user <email@tld>`_): {func}`vcs_user`
57-
- For git only: {func}`git_commit_envvars`
56+
- User (e.g., _`user <email@tld>`_): {func}`vcs_user`
57+
- Git-specific: {func}`git_commit_envvars`
5858

59-
These ensure that repositories can be cloned and created without unnecessary warnings.
59+
These fixtures ensure that repositories can be cloned and created without unnecessary warnings.
6060

6161
[`HGRCPATH`]: https://www.mercurial-scm.org/doc/hg.1.html#:~:text=UNIX%2Dlike%20environments.-,HGRCPATH,-If%20not%20set
6262
[`GIT_CONFIG`]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-GITCONFIG

0 commit comments

Comments
 (0)