1- """Command line tool for managing tmuxp workspaces.
2-
3- tmuxp.cli.load
4- ~~~~~~~~~~~~~~
5-
6- """
1+ """CLI for ``tmuxp load`` subcommand."""
72import argparse
83import importlib
94import logging
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
3835class 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
253252def _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
488485def 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