From 4a7f71bc59ff709bd9ea93fcb1f56b041c0efb0d Mon Sep 17 00:00:00 2001 From: Matthew Zipkin Date: Fri, 11 Oct 2024 18:04:59 -0400 Subject: [PATCH] skip unknown args in api docs --- docs/warnet.md | 6 +++--- resources/scripts/apidocs.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/warnet.md b/docs/warnet.md index 8c00840c8..5a934fb24 100644 --- a/docs/warnet.md +++ b/docs/warnet.md @@ -72,7 +72,7 @@ options: ### `warnet run` Run a scenario from a file. - Pass `-- --help` to get individual scenario help +Pass `-- --help` to get individual scenario help options: | name | type | required | default | @@ -153,7 +153,7 @@ options: ### `warnet bitcoin messages` Fetch messages sent between \ and \ in [chain] - Optionally, include a namespace like so: tank-name.namespace +Optionally, include a namespace like so: tank-name.namespace options: | name | type | required | default | @@ -179,7 +179,7 @@ options: ### `warnet image build` Build bitcoind and bitcoin-cli from \ at \ with the specified \. - Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry. +Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry. options: | name | type | required | default | diff --git a/resources/scripts/apidocs.py b/resources/scripts/apidocs.py index eb64fce64..cca6fdce7 100755 --- a/resources/scripts/apidocs.py +++ b/resources/scripts/apidocs.py @@ -29,7 +29,7 @@ def print_cmd(cmd, super=""): format_default_value(p["default"], p["type"]["param_type"]), ] for p in cmd["params"] - if p["name"] != "help" + if p["name"] != "help" and p["name"] != "unknown_args" ] doc += tabulate(data, headers=headers, tablefmt="github") doc += "\n\n"