Skip to content

Commit dd67679

Browse files
committed
docs(session): Correct docstrings
1 parent 36e6dce commit dd67679

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/libtmux/session.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -340,12 +340,12 @@ def show_option(
340340
return value
341341

342342
def select_window(self, target_window: t.Union[str, int]) -> "Window":
343-
"""Select window, return selected window.
343+
"""Select window and return the selected window.
344344
345345
Parameters
346346
----------
347347
window : str
348-
``target_window`` also 'last-window' (``-l``), 'next-window'
348+
``target_window`` can also be 'last-window' (``-l``), 'next-window'
349349
(``-n``), or 'previous-window' (``-p``)
350350
351351
Returns
@@ -375,12 +375,12 @@ def select_window(self, target_window: t.Union[str, int]) -> "Window":
375375
#
376376
@property
377377
def active_pane(self) -> t.Optional["Pane"]:
378-
"""Return active :class:`Pane` object."""
378+
"""Return the active :class:`Pane` object."""
379379
return self.active_window.active_pane
380380

381381
@property
382382
def active_window(self) -> "Window":
383-
"""Return active :class:`Window` object."""
383+
"""Return the active :class:`Window` object."""
384384
active_windows = self.windows.filter(window_active="1")
385385

386386
if len(active_windows) == 1:
@@ -622,6 +622,7 @@ def new_window(
622622
Returns
623623
-------
624624
:class:`Window`
625+
The newly created window.
625626
"""
626627
window_args: t.Tuple[str, ...] = ()
627628

@@ -757,7 +758,7 @@ def name(self) -> t.Optional[str]:
757758
#
758759
@property
759760
def attached_pane(self) -> t.Optional["Pane"]:
760-
"""Return active :class:`Pane` object.
761+
"""Return the active :class:`Pane` object.
761762
762763
Notes
763764
-----
@@ -774,7 +775,7 @@ def attached_pane(self) -> t.Optional["Pane"]:
774775

775776
@property
776777
def attached_window(self) -> "Window":
777-
"""Return active :class:`Window` object.
778+
"""Return the active :class:`Window` object.
778779
779780
Notes
780781
-----

0 commit comments

Comments
 (0)