Skip to content

Commit acb1c6a

Browse files
committed
cli(load): pydocstyle manual fixes
1 parent 1d0937e commit acb1c6a

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

src/tmuxp/cli/load.py

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
"""Command line tool for managing tmuxp workspaces.
2-
3-
tmuxp.cli.load
4-
~~~~~~~~~~~~~~
5-
6-
"""
1+
"""CLI for ``tmuxp load`` subcommand."""
72
import argparse
83
import importlib
94
import logging
@@ -31,11 +26,15 @@
3126
CLIColorsLiteral: TypeAlias = t.Literal[56, 88]
3227

3328
class OptionOverrides(TypedDict):
29+
"""Optional argument overrides for tmuxp load."""
30+
3431
detached: NotRequired[bool]
3532
new_session_name: NotRequired[t.Optional[str]]
3633

3734

3835
class CLILoadNamespace(argparse.Namespace):
36+
"""Typed :class:`argparse.Namespace` for tmuxp load command."""
37+
3938
workspace_files: t.List[str]
4039
socket_name: t.Optional[str]
4140
socket_path: t.Optional[str]
@@ -251,8 +250,7 @@ def _load_append_windows_to_current_session(builder: WorkspaceBuilder) -> None:
251250

252251

253252
def _setup_plugins(builder: WorkspaceBuilder) -> Session:
254-
"""
255-
Runs after before_script.
253+
"""Execute hooks for plugins running after ``before_script``.
256254
257255
Parameters
258256
----------
@@ -276,8 +274,7 @@ def load_workspace(
276274
answer_yes: bool = False,
277275
append: bool = False,
278276
) -> t.Optional[Session]:
279-
"""
280-
Load a tmux "workspace" session via tmuxp file.
277+
"""Entrypoint for ``tmuxp load``, load a tmuxp "workspace" session via config file.
281278
282279
Parameters
283280
----------
@@ -486,6 +483,7 @@ def load_workspace(
486483

487484

488485
def create_load_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
486+
"""Augment :class:`argparse.ArgumentParser` with ``load`` subcommand."""
489487
workspace_files = parser.add_argument(
490488
"workspace_files",
491489
nargs="+",

0 commit comments

Comments
 (0)