From 5473e2733c2cb98401847e73e35514cefd15f39a Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Sat, 8 Jun 2024 18:24:49 +0200 Subject: [PATCH] Clan-cli/show: more detailed description --- pkgs/clan-cli/clan_cli/__init__.py | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index 6acb18f6e..bdb1eb390 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -119,8 +119,23 @@ For more detailed information, visit: https://docs.clan.lol # Commands directly under the root i.e. "clan show" show_parser = subparsers.add_parser( "show", - help="Show the clan meta if present.", - description="Final meta results from clan/meta.json and flake arguments.", + help="Show meta about the clan if present.", + description="Show meta about the clan if present.", + epilog=( + """ +This command prints the metadata of a clan. + +Examples: + + $ clan show --flake [PATH] + Name: My Empty Clan + Description: some nice description + Icon: A path to the png + +Note: The meta results from clan/meta.json and manual flake arguments. It may not be present for clans not created via the clan-app. + +""" + ), ) show_parser.set_defaults(func=show.show_command)