From 1db1990711dfeffb9eac35abea6b28c276262f18 Mon Sep 17 00:00:00 2001 From: Zapta Date: Tue, 3 Sep 2024 13:23:59 -0700 Subject: [PATCH] Made the help text of the top apio command explicit. May do the same for the other commands in follow up changes. --- apio/__main__.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/apio/__main__.py b/apio/__main__.py index b4b361c9..cbc4a9f4 100644 --- a/apio/__main__.py +++ b/apio/__main__.py @@ -89,7 +89,6 @@ def select_commands_help(command_lines, command_names): """ result = [] - for command_line in command_lines: # Extract command name. This is the first word. # E.g.: " build Synthesize the bitstream." @@ -101,19 +100,24 @@ def select_commands_help(command_lines, command_names): return result -# ------------------------------------------------------------------ -# -- This function is executed when apio is executed without -# -- any parameter. The help is shown -# ------------------------------------------------------------------ +# --------------------------- +# -- Top click command node. +# --------------------------- @click.command( cls=ApioCLI, + help=( + "Work with FPGAs with ease. " + "For more information see https://github.com/FPGAwars/apio/wiki/Apio" + ), invoke_without_command=True, context_settings=util.context_settings(), ) @click.pass_context @click.version_option() def cli(ctx): - """Work with FPGAs with ease""" + """This function is executed when apio is invoked without + any parameter. It prints the high level usage text of Apio. + """ # -- No command typed: show help if ctx.invoked_subcommand is None: