From f5528e8d1c4f3315af1c435e7441dd0e6f0ed3b3 Mon Sep 17 00:00:00 2001
From: Tony Narlock <tony@git-pull.com>
Date: Sat, 25 Nov 2023 12:50:11 -0600
Subject: [PATCH] chore(tests[session]): pydocstyle manual fixes

---
 tests/test_session.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/tests/test_session.py b/tests/test_session.py
index 149a7f147..64fc81570 100644
--- a/tests/test_session.py
+++ b/tests/test_session.py
@@ -140,6 +140,7 @@ def test_set_show_option(session: Session) -> None:
 
 
 def test_empty_session_option_returns_None(session: Session) -> None:
+    """Verify Session.show_option returns None for unset option."""
     assert session.show_option("default-shell") is None
 
 
@@ -215,6 +216,8 @@ def test_unset_environment(session: Session) -> None:
 
 
 class PeriodRaisesBadSessionName(t.NamedTuple):
+    """Test fixture for bad session name names."""
+
     session_name: str
     raises: bool
 
@@ -227,9 +230,10 @@ class PeriodRaisesBadSessionName(t.NamedTuple):
         PeriodRaisesBadSessionName("hey moo", False),
     ],
 )
-def test_periods_raise_badsessionname(
+def test_periods_raise_bad_session_name(
     server: Server, session: Session, session_name: str, raises: bool
 ) -> None:
+    """Verify session names with periods raise BadSessionName."""
     new_name = session_name + "moo"  # used for rename / switch
     if raises:
         with pytest.raises(exc.BadSessionName):
@@ -256,6 +260,7 @@ def test_periods_raise_badsessionname(
 
 
 def test_cmd_inserts_session_id(session: Session) -> None:
+    """Verify Session.cmd() inserts session_id."""
     current_session_id = session.session_id
     last_arg = "last-arg"
     cmd = session.cmd("not-a-command", last_arg)
@@ -279,6 +284,7 @@ def test_new_window_with_environment(
     session: Session,
     environment: t.Dict[str, str],
 ) -> None:
+    """Verify new window with environment vars."""
     env = shutil.which("env")
     assert env is not None, "Cannot find usable `env` in PATH."
 
@@ -303,6 +309,7 @@ def test_new_window_with_environment_logs_warning_for_old_tmux(
     session: Session,
     caplog: pytest.LogCaptureFixture,
 ) -> None:
+    """Verify new window with environment vars create a warning if tmux is too old."""
     env = shutil.which("env")
     assert env is not None, "Cannot find usable `env` in PATH."