Skip to content

Commit db5afd1

Browse files
committed
cli(shell): Note pydocstyle updates
1 parent 635c245 commit db5afd1

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/tmuxp/cli/shell.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""CLI for ``tmuxp shell`` subcommand."""
12
import argparse
23
import os
34
import pathlib
@@ -18,6 +19,8 @@
1819

1920

2021
class CLIShellNamespace(argparse.Namespace):
22+
"""Typed :class:`argparse.Namespace` for tmuxp shell command."""
23+
2124
session_name: str
2225
socket_name: t.Optional[str]
2326
socket_path: t.Optional[str]
@@ -31,6 +34,7 @@ class CLIShellNamespace(argparse.Namespace):
3134

3235

3336
def create_shell_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
37+
"""Augment :class:`argparse.ArgumentParser` with ``shell`` subcommand."""
3438
parser.add_argument("session_name", metavar="session-name", nargs="?")
3539
parser.add_argument("window_name", metavar="window-name", nargs="?")
3640
parser.add_argument(
@@ -132,7 +136,7 @@ def command_shell(
132136
args: CLIShellNamespace,
133137
parser: t.Optional[argparse.ArgumentParser] = None,
134138
) -> None:
135-
"""Launch python shell for tmux server, session, window and pane.
139+
"""Entrypoint for ``tmuxp shell`` for tmux server, session, window and pane.
136140
137141
Priority given to loaded session/window/pane objects:
138142

0 commit comments

Comments
 (0)