Merge pull request 'Clan-cli/show: more detailed description' (#1594) from hsjobeki/clan-core:hsjobeki-main into main

2024-06-08 16:28:36 +00:00 · 2024-06-08 16:28:36 +00:00 · 6e3c2506c9
commit 6e3c2506c9
parent 006a7044f1 5473e2733c
1 changed files with 17 additions and 2 deletions
--- 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)