From 5caa88683495cdd06b04f9b91579447bd7b19a5c Mon Sep 17 00:00:00 2001 From: teh_coderer Date: Fri, 3 Feb 2023 00:09:40 -0500 Subject: [PATCH] added cmd flag options to docs --- website/generate_terminal_markdown.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/website/generate_terminal_markdown.py b/website/generate_terminal_markdown.py index ed422933cbd4..780861c441bd 100644 --- a/website/generate_terminal_markdown.py +++ b/website/generate_terminal_markdown.py @@ -113,9 +113,13 @@ def process_cmd_parsers(ctrl: ControllerDoc) -> List[Dict[str, str]]: # We do this to fix multiline docstrings for the markdown doc = " ".join(doc.split()).replace(*USER_PATH) + if (flags := action.option_strings) is not None: + flags = " ".join(flags) + actions.append( { "opt_name": action.dest if action.dest else "", + "flags": flags if flags else "", "doc": doc if doc else "", "default": f"{default}".replace(*USER_PATH), "optional": not action.required, @@ -170,14 +174,18 @@ def generate_markdown( markdown += "---\n\n## Parameters\n\n" if cmd_meta["actions"]: - markdown += "| Name | Description | Default | Optional | Choices |\n" - markdown += "| ---- | ----------- | ------- | -------- | ------- |\n" + markdown += ( + "| Name | Parameter | Description | Default | Optional | Choices |\n" + ) + markdown += ( + "| ---- | --------- | ----------- | ------- | -------- | ------- |\n" + ) for param in cmd_meta["actions"]: if isinstance(param, dict): markdown += ( - f"| {param['opt_name']} | {param['doc']} | {param['default']} " - f"| {param['optional']} | {param['choices']} |\n" + f"| {param['opt_name']} | {param['flags']} | {param['doc']} " + f"| {param['default']} | {param['optional']} | {param['choices']} |\n" ) else: markdown += "This command has no parameters\n\n"