From c34664429c762c93cb77b826dcecd5451082ab29 Mon Sep 17 00:00:00 2001 From: a-kenji Date: Tue, 28 May 2024 11:37:32 +0200 Subject: [PATCH] clan: add descriptions for reference documentation --- pkgs/clan-cli/clan_cli/__init__.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index 10b9e95e..fb2c8bcd 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -156,6 +156,7 @@ For more detailed information, visit: https://docs.clan.lol/getting-started parser_ssh = subparsers.add_parser( "ssh", help="ssh to a remote machine", + description="ssh to a remote machine", epilog=( """ This subcommand allows seamless ssh access to the nixos-image builders. @@ -262,14 +263,22 @@ For more detailed information, visit: https://docs.clan.lol/getting-started/depl ) machines.register_parser(parser_machine) - parser_vms = subparsers.add_parser("vms", help="manage virtual machines") + parser_vms = subparsers.add_parser( + "vms", help="manage virtual machines", description="manage virtual machines" + ) vms.register_parser(parser_vms) - parser_history = subparsers.add_parser("history", help="manage history") + parser_history = subparsers.add_parser( + "history", + help="manage history", + description="manage history", + ) history.register_parser(parser_history) parser_flash = subparsers.add_parser( - "flash", help="flash machines to usb sticks or into isos" + "flash", + help="flash machines to usb sticks or into isos", + description="flash machines to usb sticks or into isos", ) flash.register_parser(parser_flash)