Skip to content

Commit 023aa2f

Browse files
committed
chore(pane): pydocstyle manual fixes
1 parent 9d047bb commit 023aa2f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/libtmux/pane.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,13 @@ class Pane(Obj):
7070
server: "Server"
7171

7272
def refresh(self) -> None:
73+
"""Refresh pane attributes from tmux."""
7374
assert isinstance(self.pane_id, str)
7475
return super()._refresh(obj_key="pane_id", obj_id=self.pane_id)
7576

7677
@classmethod
7778
def from_pane_id(cls, server: "Server", pane_id: str) -> "Pane":
79+
"""Create Pane from existing pane_id."""
7880
pane = fetch_obj(
7981
obj_key="pane_id",
8082
obj_id=pane_id,
@@ -89,13 +91,15 @@ def from_pane_id(cls, server: "Server", pane_id: str) -> "Pane":
8991
#
9092
@property
9193
def window(self) -> "Window":
94+
"""Parent window of pane."""
9295
assert isinstance(self.window_id, str)
9396
from libtmux.window import Window
9497

9598
return Window.from_window_id(server=self.server, window_id=self.window_id)
9699

97100
@property
98101
def session(self) -> "Session":
102+
"""Parent session of pane."""
99103
return self.window.session
100104

101105
"""
@@ -375,11 +379,13 @@ def reset(self) -> "Pane":
375379
# Dunder
376380
#
377381
def __eq__(self, other: object) -> bool:
382+
"""Equal operator for :class:`Pane` object."""
378383
if isinstance(other, Pane):
379384
return self.pane_id == other.pane_id
380385
return False
381386

382387
def __repr__(self) -> str:
388+
"""Representation of :class:`Pane` object."""
383389
return f"{self.__class__.__name__}({self.pane_id} {self.window})"
384390

385391
#

0 commit comments

Comments
 (0)