Skip to content

Commit d2e4990

Browse files
committed
chore(tests[legacy_session]): pydocstyle manual fixes
1 parent 833aead commit d2e4990

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

tests/legacy_api/test_session.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ def test_set_show_option(session: Session) -> None:
140140

141141

142142
def test_empty_session_option_returns_None(session: Session) -> None:
143+
"""Verify Session.show_option returns None for unset option."""
143144
assert session.show_option("default-shell") is None
144145

145146

@@ -221,6 +222,7 @@ def test_unset_environment(session: Session) -> None:
221222
def test_periods_raise_badsessionname(
222223
server: Server, session: Session, session_name: str, raises: bool
223224
) -> None:
225+
"""Verify session names with periods raise BadSessionName."""
224226
new_name = session_name + "moo" # used for rename / switch
225227
if raises:
226228
with pytest.raises(exc.BadSessionName):
@@ -247,6 +249,7 @@ def test_periods_raise_badsessionname(
247249

248250

249251
def test_cmd_inserts_session_id(session: Session) -> None:
252+
"""Verify Session.cmd() inserts session_id."""
250253
current_session_id = session.id
251254
last_arg = "last-arg"
252255
cmd = session.cmd("not-a-command", last_arg)
@@ -270,6 +273,7 @@ def test_new_window_with_environment(
270273
session: Session,
271274
environment: t.Dict[str, str],
272275
) -> None:
276+
"""Verify new window with environment vars."""
273277
env = shutil.which("env")
274278
assert env is not None, "Cannot find usable `env` in PATH."
275279

@@ -294,6 +298,7 @@ def test_new_window_with_environment_logs_warning_for_old_tmux(
294298
session: Session,
295299
caplog: pytest.LogCaptureFixture,
296300
) -> None:
301+
"""Verify new window with environment vars create a warning if tmux is too old."""
297302
env = shutil.which("env")
298303
assert env is not None, "Cannot find usable `env` in PATH."
299304

0 commit comments

Comments
 (0)