Skip to content

Commit e45dcf2

Browse files
committed
docs: Improve pytest_plugin.py
1 parent 70ac1eb commit e45dcf2

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

src/libtmux/pytest_plugin.py

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
"""libtmux pytest plugin."""
1+
"""Provide a pytest plugin that supplies libtmux testing fixtures.
2+
3+
This plugin integrates with pytest to offer session, window, and environment
4+
fixtures tailored for tmux-based tests. It ensures stable test environments by
5+
creating and tearing down temporary sessions and windows for each test as
6+
needed.
7+
8+
Notes
9+
-----
10+
The existing doctests embedded within each fixture are preserved to maintain
11+
clarity and verify core behaviors.
12+
13+
"""
214

315
from __future__ import annotations
416

@@ -67,7 +79,8 @@ def config_file(user_path: pathlib.Path) -> pathlib.Path:
6779
6880
- ``base-index -g 1``
6981
70-
These guarantee pane and windows targets can be reliably referenced and asserted.
82+
These guarantee pane and windows targets can be reliably referenced
83+
and asserted.
7184
7285
Note: You will need to set the home directory, see :ref:`set_home`.
7386
"""
@@ -85,7 +98,8 @@ def config_file(user_path: pathlib.Path) -> pathlib.Path:
8598
def clear_env(monkeypatch: pytest.MonkeyPatch) -> None:
8699
"""Clear out any unnecessary environment variables that could interrupt tests.
87100
88-
tmux show-environment tests were being interrupted due to a lot of crazy env vars.
101+
tmux show-environment tests were being interrupted due to a lot of
102+
crazy env vars.
89103
"""
90104
for k in os.environ:
91105
if not any(

0 commit comments

Comments
 (0)