Skip to content

Commit 184ef8d

Browse files
committed
cli(convert): Note pydocstyle updates
1 parent 788617f commit 184ef8d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/tmuxp/cli/convert.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
"""CLI for ``tmuxp convert`` subcommand."""
12
import argparse
23
import os
34
import pathlib
@@ -16,6 +17,7 @@
1617
def create_convert_subparser(
1718
parser: argparse.ArgumentParser,
1819
) -> argparse.ArgumentParser:
20+
"""Augment :class:`argparse.ArgumentParser` with ``convert`` subcommand."""
1921
workspace_file = parser.add_argument(
2022
dest="workspace_file",
2123
type=str,
@@ -40,6 +42,8 @@ def create_convert_subparser(
4042

4143

4244
class ConvertUnknownFileType(exc.TmuxpException):
45+
"""Raise if tmuxp convert encounters an unknown filetype."""
46+
4347
def __init__(self, ext: str, *args: object, **kwargs: object) -> None:
4448
return super().__init__(
4549
f"Unknown filetype: {ext} (valid: [.json, .yaml, .yml])"
@@ -51,7 +55,7 @@ def command_convert(
5155
answer_yes: bool,
5256
parser: t.Optional[argparse.ArgumentParser] = None,
5357
) -> None:
54-
"""Convert a tmuxp config between JSON and YAML."""
58+
"""Entrypoint for ``tmuxp convert`` convert a tmuxp config between JSON and YAML."""
5559
workspace_file = find_workspace_file(
5660
workspace_file, workspace_dir=get_workspace_dir()
5761
)

0 commit comments

Comments
 (0)