|
27 | 27 |
|
28 | 28 |
|
29 | 29 | class WorkspaceBuilder: |
| 30 | + """Load workspace from workspace :py:obj:`dict` object. |
30 | 31 |
|
31 | | - """ |
32 | | - Load workspace from session :py:obj:`dict`. |
33 | | -
|
34 | | - Build tmux workspace from a configuration. Creates and names windows, sets |
35 | | - options, splits windows into panes. |
| 32 | + Build tmux workspace from a configuration. Creates and names windows, sets options, |
| 33 | + splits windows into panes. |
36 | 34 |
|
37 | 35 | Examples |
38 | 36 | -------- |
@@ -145,8 +143,7 @@ def __init__( |
145 | 143 | server: Server, |
146 | 144 | plugins: t.List[t.Any] = [], |
147 | 145 | ) -> None: |
148 | | - """ |
149 | | - Initialize workspace loading. |
| 146 | + """Initialize workspace loading. |
150 | 147 |
|
151 | 148 | Parameters |
152 | 149 | ---------- |
@@ -192,14 +189,12 @@ def session_exists(self, session_name: str) -> bool: |
192 | 189 | return True |
193 | 190 |
|
194 | 191 | def build(self, session: t.Optional[Session] = None, append: bool = False) -> None: |
195 | | - """ |
196 | | - Build tmux workspace in session. |
| 192 | + """Build tmux workspace in session. |
197 | 193 |
|
198 | 194 | Optionally accepts ``session`` to build with only session object. |
199 | 195 |
|
200 | | - Without ``session``, it will use :class:`libmtux.Server` at |
201 | | - ``self.server`` passed in on initialization to create a new Session |
202 | | - object. |
| 196 | + Without ``session``, it will use :class:`libmtux.Server` at ``self.server`` |
| 197 | + passed in on initialization to create a new Session object. |
203 | 198 |
|
204 | 199 | Parameters |
205 | 200 | ---------- |
@@ -318,8 +313,7 @@ def build(self, session: t.Optional[Session] = None, append: bool = False) -> No |
318 | 313 | def iter_create_windows( |
319 | 314 | self, session: Session, append: bool = False |
320 | 315 | ) -> t.Iterator[t.Any]: |
321 | | - """ |
322 | | - Return :class:`libtmux.Window` iterating through session config dict. |
| 316 | + """Return :class:`libtmux.Window` iterating through session config dict. |
323 | 317 |
|
324 | 318 | Generator yielding :class:`libtmux.Window` by iterating through |
325 | 319 | ``sconf['windows']``. |
@@ -417,8 +411,7 @@ def iter_create_windows( |
417 | 411 | def iter_create_panes( |
418 | 412 | self, w: Window, wconf: t.Dict[str, t.Any] |
419 | 413 | ) -> t.Iterator[t.Any]: |
420 | | - """ |
421 | | - Return :class:`libtmux.Pane` iterating through window config dict. |
| 414 | + """Return :class:`libtmux.Pane` iterating through window config dict. |
422 | 415 |
|
423 | 416 | Run ``shell_command`` with ``$ tmux send-keys``. |
424 | 417 |
|
|
0 commit comments