Skip to content

Commit

Permalink
skip unknown args in api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pinheadmz committed Oct 11, 2024
1 parent 577cdbb commit 4a7f71b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/warnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -153,7 +153,7 @@ options:
### `warnet bitcoin messages`
Fetch messages sent between \<tank_a pod name> and \<tank_b pod name> 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 |
Expand All @@ -179,7 +179,7 @@ options:

### `warnet image build`
Build bitcoind and bitcoin-cli from \<repo> at \<commit_sha> with the specified \<tags>.
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 |
Expand Down
2 changes: 1 addition & 1 deletion resources/scripts/apidocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 4a7f71b

Please sign in to comment.