Skip to content

Commit d4eb1f2

Browse files
committed
cli(freeze): Note pydocstyle updates
1 parent f109a54 commit d4eb1f2

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/tmuxp/cli/freeze.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""CLI for ``tmuxp freeze`` subcommand."""
12
import argparse
23
import os
34
import pathlib
@@ -21,6 +22,8 @@
2122

2223

2324
class CLIFreezeNamespace(argparse.Namespace):
25+
"""Typed :class:`argparse.Namespace` for tmuxp freeze command."""
26+
2427
session_name: str
2528
socket_name: t.Optional[str]
2629
socket_path: t.Optional[str]
@@ -34,6 +37,7 @@ class CLIFreezeNamespace(argparse.Namespace):
3437
def create_freeze_subparser(
3538
parser: argparse.ArgumentParser,
3639
) -> argparse.ArgumentParser:
40+
"""Augment :class:`argparse.ArgumentParser` with ``freeze`` subcommand."""
3741
parser.add_argument(
3842
dest="session_name",
3943
metavar="session-name",
@@ -87,10 +91,10 @@ def command_freeze(
8791
args: CLIFreezeNamespace,
8892
parser: t.Optional[argparse.ArgumentParser] = None,
8993
) -> None:
90-
"""Snapshot a tmux session into a tmuxp workspace.
94+
"""Entrypoint for ``tmuxp freeze``, snapshot a tmux session into a tmuxp workspace.
9195
92-
If SESSION_NAME is provided, snapshot that session. Otherwise, use the
93-
current session.
96+
If SESSION_NAME is provided, snapshot that session. Otherwise, use the current
97+
session.
9498
"""
9599
server = Server(socket_name=args.socket_name, socket_path=args.socket_path)
96100

0 commit comments

Comments
 (0)