docs(refactor): Remove outdated tmux version references (#608)

why: Clean up docstrings/comments referencing old tmux versions now that 3.2a is minimum
what:
- common.py: Update error message, simplify handle_option_error docstring
- server.py: Remove "tmux 2.1 and up only" from exact param, remove 1.9-dev comment
- session.py: Remove "(tmux 3.2+)" from direction param, remove 1.9-dev comment
- window.py: Remove "tmux 3.0+ only" from environment param, update deprecation msg
- pane.py: Remove "tmux 3.0+ only" from environment params, remove 1.9-dev comment
- neo.py: Remove QUIRK_TMUX_3_1_X_0001 documentation (no longer applicable)
- Update test assertions for new error message

Author: tony

src/libtmux/common.py

@@ -288,7 +288,7 @@ def get_version() -> LooseVersion:
                 return LooseVersion(f"{TMUX_MAX_VERSION}-openbsd")
             msg = (
                 f"libtmux supports tmux {TMUX_MIN_VERSION} and greater. This system"
-                " is running tmux 1.3 or earlier."
+                " does not meet the minimum tmux version requirement."
             )
             raise exc.LibTmuxException(
                 msg,
@@ -456,17 +456,12 @@ def session_check_name(session_name: str | None) -> None:
 def handle_option_error(error: str) -> type[exc.OptionError]:
     """Raise exception if error in option command found.
 
-    In tmux 3.0, show-option and show-window-option return invalid option instead of
-    unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
-
-    In tmux >2.4, there are 3 different types of option errors:
+    There are 3 different types of option errors:
 
     - unknown option
     - invalid option
     - ambiguous option
 
-    In tmux <2.4, unknown option was the only option.
-
     All errors raised will have the base error of :exc:`exc.OptionError`. So to
     catch any option error, use ``except exc.OptionError``.
 

src/libtmux/neo.py

@@ -24,16 +24,6 @@
 OutputsRaw = list[OutputRaw]
 
 
-"""
-Quirks:
-
-QUIRK_TMUX_3_1_X_0001:
-
-- tmux 3.1 and 3.1a:
-- server crash with list-panes w/ buffer_created, client_activity, client_created
-"""
-
-
 @dataclasses.dataclass()
 class Obj:
     """Dataclass of generic tmux object."""
@@ -43,14 +33,11 @@ class Obj:
     active_window_index: str | None = None
     alternate_saved_x: str | None = None
     alternate_saved_y: str | None = None
-    # See QUIRK_TMUX_3_1_X_0001
     buffer_name: str | None = None
     buffer_sample: str | None = None
     buffer_size: str | None = None
-    # See QUIRK_TMUX_3_1_X_0001
     client_cell_height: str | None = None
     client_cell_width: str | None = None
-    # See QUIRK_TMUX_3_1_X_0001
     client_discarded: str | None = None
     client_flags: str | None = None
     client_height: str | None = None

src/libtmux/pane.py

@@ -586,7 +586,7 @@ def split(
         size: int, optional
             Cell/row or percentage to occupy with respect to current window.
         environment: dict, optional
-            Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.
+            Environmental variables for new pane. Passthrough to ``-e``.
 
         Examples
         --------
@@ -662,7 +662,6 @@ def split(
         tmux_args += ("-P", "-F{}".format("".join(tmux_formats)))  # output
 
         if start_directory:
-            # as of 2014-02-08 tmux 1.9-dev doesn't expand ~ in new-window -c.
             start_path = pathlib.Path(start_directory).expanduser()
             tmux_args += (f"-c{start_path}",)
 
@@ -880,7 +879,7 @@ def split_window(
         percent: int, optional
             percentage to occupy with respect to current pane
         environment: dict, optional
-            Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.
+            Environmental variables for new pane. Passthrough to ``-e``.
 
         Notes
         -----

src/libtmux/server.py

@@ -324,7 +324,6 @@ def has_session(self, target_session: str, exact: bool = True) -> bool:
         exact : bool
             match the session name exactly. tmux uses fnmatch by default.
             Internally prepends ``=`` to the session in ``$ tmux has-session``.
-            tmux 2.1 and up only.
 
         Raises
         ------
@@ -540,7 +539,6 @@ def new_session(
             tmux_args += ("-d",)
 
         if start_directory:
-            # as of 2014-02-08 tmux 1.9-dev doesn't expand ~ in new-session -c.
             start_directory = pathlib.Path(start_directory).expanduser()
             tmux_args += ("-c", str(start_directory))
 

src/libtmux/session.py

@@ -610,7 +610,7 @@ def new_window(
                 window upon completion is desired.
 
         direction : WindowDirection, optional
-            Insert window before or after target window (tmux 3.2+).
+            Insert window before or after target window.
 
         target_window : str, optional
             Used by :meth:`Window.new_window` to specify the target window.
@@ -664,7 +664,6 @@ def new_window(
 
         # Catch empty string and default (`None`)
         if start_directory:
-            # as of 2014-02-08 tmux 1.9-dev doesn't expand ~ in new-window -c.
             start_directory = pathlib.Path(start_directory).expanduser()
             window_args += (f"-c{start_directory}",)
 

src/libtmux/window.py

@@ -294,7 +294,7 @@ def split(
         size: int, optional
             Cell/row or percentage to occupy with respect to current window.
         environment: dict, optional
-            Environmental variables for new pane. tmux 3.0+ only. Passthrough to ``-e``.
+            Environmental variables for new pane. Passthrough to ``-e``.
         """
         active_pane = self.active_pane or self.panes[0]
         return active_pane.split(
@@ -891,7 +891,7 @@ def split_window(
             # Deprecated in 3.1 in favor of -l
             warnings.warn(
                 f'Deprecated in favor of size="{str(percent).rstrip("%")}%" '
-                ' ("-l" flag) in tmux 3.1+.',
+                '(using the "-l" flag).',
                 category=DeprecationWarning,
                 stacklevel=2,
             )

tests/legacy_api/test_common.py

@@ -102,7 +102,7 @@ def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> Hi:
     monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
     with pytest.raises(LibTmuxException) as exc_info:
         get_version()
-    exc_info.match("is running tmux 1.3 or earlier")
+    exc_info.match("does not meet the minimum tmux version requirement")
 
 
 def test_ignores_letter_versions(monkeypatch: pytest.MonkeyPatch) -> None:

tests/test_common.py

@@ -321,7 +321,7 @@ class VersionParsingFixture(t.NamedTuple):
         mock_platform=None,
         expected_version=None,
         raises=True,
-        exc_msg_regex="is running tmux 1.3 or earlier",
+        exc_msg_regex="does not meet the minimum tmux version requirement",
     ),
 ]