Skip to content

Commit 2388ed3

Browse files
committed
docs: Improve formatting consistency and type hints in pytest plugin docs
1 parent ad42c9a commit 2388ed3

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/pytest-plugin.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ When the plugin is enabled and `pytest` is run, these overridable fixtures are a
4343
- `/home/` ({func}`home_path`)
4444
- `/home/${user}` ({func}`user_path`)
4545
- Set the home directory:
46-
- Patch `$HOME` to point to {func}`user_path` using ({func}`set_home`)
46+
- 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`
@@ -107,12 +107,14 @@ cases, you can use {func}`git_commit_envvars`:
107107

108108
```python
109109
import pytest
110+
from typing import Dict, Any
111+
from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
110112

111113
@pytest.fixture
112114
def my_git_repo(
113115
create_git_remote_repo: CreateRepoPytestFixtureFn,
114116
gitconfig: pathlib.Path,
115-
git_commit_envvars: "_ENV",
117+
git_commit_envvars: Dict[str, Any],
116118
) -> pathlib.Path:
117119
"""Copy the session-scoped Git repository to a temporary directory."""
118120
repo_path = create_git_remote_repo()

0 commit comments

Comments
 (0)