Skip to content

Commit becbefc

Browse files
committed
fix(cli): Fix docs
sphinx-argparse: - won't show newlines due to a docutils/sphinx limitation - can't point to a tuple create_parser function
1 parent 5de6dfe commit becbefc

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

docs/cli/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ completion
2828
:func: create_parser
2929
:prog: vcspull
3030
:nosubcommands:
31+
:nodescription:
3132
3233
subparser_name : @replace
3334
See :ref:`cli-sync`

docs/cli/sync.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
:func: create_parser
1313
:prog: vcspull
1414
:path: sync
15+
:nodescription:
1516
```
1617

1718
## Filtering repos

src/vcspull/cli/__init__.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
).strip()
3131

3232

33-
def create_parser():
33+
def create_parser(return_subparsers: bool = False):
3434
parser = argparse.ArgumentParser(
3535
prog="vcspull",
3636
formatter_class=argparse.RawDescriptionHelpFormatter,
@@ -59,11 +59,13 @@ def create_parser():
5959
)
6060
create_sync_subparser(sync_parser)
6161

62-
return parser, sync_parser
62+
if return_subparsers:
63+
return parser, sync_parser
64+
return parser
6365

6466

6567
def cli(args=None):
66-
parser, sync_parser = create_parser()
68+
parser, sync_parser = create_parser(return_subparsers=True)
6769
args = parser.parse_args(args)
6870

6971
setup_logger(log=log, level=args.log_level.upper())

0 commit comments

Comments
 (0)