Skip to content

Commit 4a935b4

Browse files
committed
fix: Missing comments
1 parent 69be574 commit 4a935b4

File tree

4 files changed

+33
-20
lines changed

4 files changed

+33
-20
lines changed

src/libtmux/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# flake8: NOQA W605
1+
# flake8: NOQA: W605
22
"""Helper methods and mixins.
33
44
libtmux.common

src/libtmux/pane.py

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# flake8: NOQA W605
1+
# flake8: NOQA: W605
22
"""Pythonization of the :ref:`tmux(1)` pane.
33
44
libtmux.pane
@@ -102,8 +102,10 @@ def window(self) -> "Window":
102102
def session(self) -> "Session":
103103
return self.window.session
104104

105-
#
106-
#
105+
"""
106+
Commands (pane-scoped)
107+
"""
108+
107109
def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
108110
"""Return :meth:`Server.cmd` defaulting to ``target_pane`` as target.
109111
@@ -117,8 +119,10 @@ def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
117119

118120
return self.server.cmd(cmd, *args, **kwargs)
119121

120-
#
121-
#
122+
"""
123+
Commands (tmux-like)
124+
"""
125+
122126
def resize_pane(self, *args: t.Any, **kwargs: t.Any) -> "Pane":
123127
"""
124128
``$ tmux resize-pane`` of pane and return ``self``.
@@ -274,11 +278,13 @@ def display_message(
274278
self.cmd("display-message", cmd)
275279
return None
276280

277-
#
278-
#
279-
# These are commands that climb to the parent scope's methods with
280-
# additional scoped window info.
281-
#
281+
"""
282+
Commands ("climber"-helpers)
283+
284+
These are commands that climb to the parent scope's methods with
285+
additional scoped window info.
286+
"""
287+
282288
def select_pane(self) -> "Pane":
283289
"""
284290
Select pane. Return ``self``.
@@ -322,8 +328,10 @@ def split_window(
322328
percent=percent,
323329
)
324330

325-
#
326-
#
331+
"""
332+
Commands (helpers)
333+
"""
334+
327335
def set_width(self, width: int) -> "Pane":
328336
"""
329337
Set width of pane.

src/libtmux/session.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,10 @@ def cmd(self, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
164164
args = new_args
165165
return self.server.cmd(*args, **kwargs)
166166

167-
#
168-
#
167+
"""
168+
Commands (tmux-like)
169+
"""
170+
169171
def set_option(
170172
self, option: str, value: t.Union[str, int], _global: bool = False
171173
) -> "Session":

src/libtmux/window.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,10 @@ def panes(self) -> QueryList["Pane"]: # type: ignore
125125

126126
return QueryList(panes)
127127

128-
#
129-
#
128+
"""
129+
Commands (pane-scoped)
130+
"""
131+
130132
def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
131133
"""Return :meth:`Server.cmd` defaulting to ``target_window`` as target.
132134
@@ -140,8 +142,10 @@ def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
140142

141143
return self.server.cmd(cmd, *args, **kwargs)
142144

143-
#
144-
#
145+
"""
146+
Commands (tmux-like)
147+
"""
148+
145149
def select_pane(self, target_pane: t.Union[str, int]) -> t.Optional["Pane"]:
146150
"""
147151
Return selected :class:`Pane` through ``$ tmux select-pane``.
@@ -218,7 +222,6 @@ def split_window(
218222
"""
219223
tmux_formats = ["#{pane_id}" + FORMAT_SEPARATOR]
220224

221-
# 2013-10-18 LOOK AT THIS, rm'd it..
222225
tmux_args: t.Tuple[str, ...] = ()
223226

224227
if target is not None:

0 commit comments

Comments
 (0)