docs(docstrings): Fix RST formatting errors in docstrings

why: Sphinx documentation build was failing with RST parsing errors
what:
- Fix malformed backticks in pane.py capture_pane docstring
- Fix parameter format to use NumPy style (param : type, optional)
- Convert Markdown code blocks to RST format in options.py module docstring
- Fix RST link syntax for Issue 55 reference in common.py
- Fix parameter name mismatch (option -> value) in common.py set_environment
- Fix type annotation in hooks.py set_hook docstring (str -> int | str)

Author: tony

src/libtmux/common.py

@@ -66,7 +66,7 @@ def set_environment(self, name: str, value: str) -> None:
         ----------
         name : str
             the environment variable name. such as 'PATH'.
-        option : str
+        value : str
             environment value.
         """
         args = ["set-environment"]
@@ -427,9 +427,8 @@ def has_minimum_version(raises: bool = True) -> bool:
         No longer returns version, returns True or False
 
     .. versionchanged:: 0.1.7
-        Versions will now remove trailing letters per `Issue 55`_.
-
-        .. _Issue 55: https://github.com/tmux-python/tmuxp/issues/55.
+        Versions will now remove trailing letters per
+        `Issue 55 <https://github.com/tmux-python/tmuxp/issues/55>`_.
     """
     if get_version() < LooseVersion(TMUX_MIN_VERSION):
         if raises:

src/libtmux/hooks.py

@@ -127,7 +127,7 @@ def set_hook(
         ----------
         hook : str
             hook to set, e.g. 'aggressive-resize'
-        value : str
+        value : int | str
             hook command.
 
         Raises

src/libtmux/options.py

@@ -52,19 +52,17 @@
 Inherited options
 -----------------
 
-`tmux show-options` -A can include inherited options. The raw output of an inherited
-option is detected by the key having a *:
+``tmux show-options`` -A can include inherited options. The raw output of an inherited
+option is detected by the key having a ``*``::
 
-```
-visual-activity* on
-visual-bell* off
-```
+    visual-activity* on
+    visual-bell* off
 
-A list of options that are inherited is kept at `Options.context._inherited_options` and
-`Options.context.inherited_options`.
+A list of options that are inherited is kept at ``Options.context._inherited_options`` and
+``Options.context.inherited_options``.
 
 They are mixed with the normal options,
-to differentiate them, run `show_options()` without ``include_inherited=True``.
+to differentiate them, run ``show_options()`` without ``include_inherited=True``.
 """
 
 from __future__ import annotations
@@ -604,7 +602,7 @@ def set_option(
 
         .. deprecated:: 0.28
 
-           Deprecated by ``g`` for global, use `global_`` instead.
+           Deprecated by ``g`` for global, use ``global_`` instead.
 
         Raises
         ------

src/libtmux/pane.py

@@ -326,24 +326,24 @@ def capture_pane(
 
         ``$ tmux capture-pane`` to pane.
         ``$ tmux capture-pane -S -10`` to pane.
-        ``$ tmux capture-pane`-E 3` to pane.
-        ``$ tmux capture-pane`-S - -E -` to pane.
+        ``$ tmux capture-pane -E 3`` to pane.
+        ``$ tmux capture-pane -S - -E -`` to pane.
 
         Parameters
         ----------
-        start: [str,int]
+        start : str | int, optional
             Specify the starting line number.
             Zero is the first line of the visible pane.
             Positive numbers are lines in the visible pane.
             Negative numbers are lines in the history.
-            `-` is the start of the history.
+            ``-`` is the start of the history.
             Default: None
-        end: [str,int]
+        end : str | int, optional
             Specify the ending line number.
             Zero is the first line of the visible pane.
             Positive numbers are lines in the visible pane.
             Negative numbers are lines in the history.
-            `-` is the end of the visible pane
+            ``-`` is the end of the visible pane.
             Default: None
         """
         cmd = ["capture-pane", "-p"]

src/libtmux/server.py

@@ -487,10 +487,10 @@ def new_session(
             when the command exits. NOTE: When this command exits the window
             will close.  This feature is useful for long-running processes
             where the closing of the window upon completion is desired.
-        x : [int, str], optional
+        x : int | str, optional
             Force the specified width instead of the tmux default for a
             detached session
-        y : [int, str], optional
+        y : int | str, optional
             Force the specified height instead of the tmux default for a
             detached session