Skip to content

Commit d1e2436

Browse files
committed
DOC201 - return is not documented in docstring
1 parent 8596030 commit d1e2436

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

src/pre_commit_terraform/_cli.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ def invoke_cli_app(cli_args: list[str]) -> ReturnCodeType:
1818
1919
Includes initializing parsers of all the sub-apps and
2020
choosing what to execute.
21+
22+
Returns:
23+
ReturnCodeType: The return code of the app.
2124
"""
2225
root_cli_parser = initialize_argument_parser()
2326
parsed_cli_args = root_cli_parser.parse_args(cli_args)

src/pre_commit_terraform/_cli_parsing.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ def attach_subcommand_parsers_to(root_cli_parser: ArgumentParser, /) -> None:
3232

3333

3434
def initialize_argument_parser() -> ArgumentParser:
35-
"""Return the root argument parser with sub-commands."""
35+
"""Return the root argument parser with sub-commands.
36+
37+
Returns:
38+
ReturnCodeType: The return code of the app.
39+
"""
3640
root_cli_parser = ArgumentParser(prog=f'python -m {__package__ !s}')
3741
attach_subcommand_parsers_to(root_cli_parser)
3842
return root_cli_parser

0 commit comments

Comments
 (0)