Skip to content

Commit 224982f

Browse files
committed
docs: Add return type annotations and improve fixture docstrings
1 parent 85efed5 commit 224982f

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
@@ -75,7 +75,8 @@ To set up a temporary home directory, use the {func}`set_home` fixture with `aut
7575
import pytest
7676

7777
@pytest.fixture(autouse=True)
78-
def setup_home(set_home: None):
78+
def setup_home(set_home: None) -> None:
79+
"""Configure a temporary home directory for testing."""
7980
pass
8081
```
8182

@@ -99,7 +100,8 @@ Use the {func}`set_gitconfig` fixture with `autouse=True`:
99100
import pytest
100101

101102
@pytest.fixture(autouse=True)
102-
def setup_git(set_gitconfig: None):
103+
def setup_git(set_gitconfig: None) -> None:
104+
"""Configure Git settings for testing."""
103105
pass
104106
```
105107

0 commit comments

Comments
 (0)