27
27
28
28
@dataclasses .dataclass ()
29
29
class Pane (Obj ):
30
- """
31
- A :term:`tmux(1)` :term:`Pane` [pane_manual]_.
30
+ """:term:`tmux(1)` :term:`Pane` [pane_manual]_.
32
31
33
32
``Pane`` instances can send commands directly to a pane, or traverse
34
33
between linked tmux objects.
@@ -124,8 +123,7 @@ def cmd(self, cmd: str, *args: t.Any, **kwargs: t.Any) -> tmux_cmd:
124
123
"""
125
124
126
125
def resize_pane (self , * args : t .Any , ** kwargs : t .Any ) -> "Pane" :
127
- """
128
- ``$ tmux resize-pane`` of pane and return ``self``.
126
+ """Resize tmux pane.
129
127
130
128
Parameters
131
129
----------
@@ -161,8 +159,7 @@ def capture_pane(
161
159
start : t .Union ["t.Literal['-']" , t .Optional [int ]] = None ,
162
160
end : t .Union ["t.Literal['-']" , t .Optional [int ]] = None ,
163
161
) -> t .Union [str , t .List [str ]]:
164
- """
165
- Capture text from pane.
162
+ """Capture text from pane.
166
163
167
164
``$ tmux capture-pane`` to pane.
168
165
``$ tmux capture-pane -S -10`` to pane.
@@ -259,8 +256,7 @@ def display_message(self, cmd: str, get_text: "t.Literal[False]") -> None:
259
256
def display_message (
260
257
self , cmd : str , get_text : bool = False
261
258
) -> t .Optional [t .Union [str , t .List [str ]]]:
262
- """
263
- ``$ tmux display-message`` to the pane.
259
+ """Display message to pane.
264
260
265
261
Displays a message in target-client status line.
266
262
@@ -286,8 +282,7 @@ def display_message(
286
282
"""
287
283
288
284
def select_pane (self ) -> "Pane" :
289
- """
290
- Select pane. Return ``self``.
285
+ """Select pane.
291
286
292
287
To select a window object asynchrously. If a ``pane`` object exists
293
288
and is no longer longer the current window, ``w.select_pane()``
@@ -306,8 +301,7 @@ def split_window(
306
301
start_directory : t .Optional [str ] = None ,
307
302
percent : t .Optional [int ] = None ,
308
303
) -> "Pane" : # New Pane, not self
309
- """
310
- Split window at pane and return newly created :class:`Pane`.
304
+ """Split window at pane and return newly created :class:`Pane`.
311
305
312
306
Parameters
313
307
----------
@@ -333,8 +327,7 @@ def split_window(
333
327
"""
334
328
335
329
def set_width (self , width : int ) -> "Pane" :
336
- """
337
- Set width of pane.
330
+ """Set pane width.
338
331
339
332
Parameters
340
333
----------
@@ -345,8 +338,7 @@ def set_width(self, width: int) -> "Pane":
345
338
return self
346
339
347
340
def set_height (self , height : int ) -> "Pane" :
348
- """
349
- Set height of pane.
341
+ """Set pane height.
350
342
351
343
Parameters
352
344
----------
@@ -357,8 +349,7 @@ def set_height(self, height: int) -> "Pane":
357
349
return self
358
350
359
351
def enter (self ) -> "Pane" :
360
- """
361
- Send carriage return to pane.
352
+ """Send carriage return to pane.
362
353
363
354
``$ tmux send-keys`` send Enter to the pane.
364
355
"""
0 commit comments