Skip to content

Commit 85efed5

Browse files
committed
docs: Fix merge conflict in my_git_repo docstring
1 parent 63ddfe7 commit 85efed5

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/pytest-plugin.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,18 @@ cases, you can use {func}`git_commit_envvars`:
109109
```python
110110
import pytest
111111
from typing import Dict, Any
112-
from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
112+
from libvcs.pytest_plugin import CreateRepoPytestFixtureFn, git_remote_repo_single_commit_post_init
113113

114114
@pytest.fixture
115115
def my_git_repo(
116116
create_git_remote_repo: CreateRepoPytestFixtureFn,
117117
gitconfig: pathlib.Path,
118118
git_commit_envvars: Dict[str, Any],
119119
) -> pathlib.Path:
120-
"""Copy the session-scoped Git repository to a temporary directory."""
120+
"""Create a fresh Git repository in a temporary directory.
121+
122+
This fixture demonstrates how to create a Git repository with custom commit settings.
123+
"""
121124
repo_path = create_git_remote_repo()
122125
git_remote_repo_single_commit_post_init(
123126
remote_repo_path=repo_path,
@@ -134,13 +137,14 @@ Use the {func}`set_hgconfig` fixture with `autouse=True`:
134137
import pytest
135138

136139
@pytest.fixture(autouse=True)
137-
def setup_hg(set_hgconfig: None):
140+
def setup_hg(set_hgconfig: None) -> None:
141+
"""Configure Mercurial settings for testing."""
138142
pass
139143
```
140144

141145
## Examples
142146

143-
For usage examples, refer to libvcs's own [tests/](https://github.com/vcs-python/libvcs/tree/master/tests).
147+
For more usage examples, refer to libvcs's own [tests/](https://github.com/vcs-python/libvcs/tree/master/tests).
144148

145149
## API Reference
146150

0 commit comments

Comments
 (0)