Skip to content

Commit 4a7f71b

Browse files
committed
skip unknown args in api docs
1 parent 577cdbb commit 4a7f71b

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/warnet.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ options:
7272

7373
### `warnet run`
7474
Run a scenario from a file.
75-
Pass `-- --help` to get individual scenario help
75+
Pass `-- --help` to get individual scenario help
7676

7777
options:
7878
| name | type | required | default |
@@ -153,7 +153,7 @@ options:
153153
### `warnet bitcoin messages`
154154
Fetch messages sent between \<tank_a pod name> and \<tank_b pod name> in [chain]
155155

156-
Optionally, include a namespace like so: tank-name.namespace
156+
Optionally, include a namespace like so: tank-name.namespace
157157

158158
options:
159159
| name | type | required | default |
@@ -179,7 +179,7 @@ options:
179179

180180
### `warnet image build`
181181
Build bitcoind and bitcoin-cli from \<repo> at \<commit_sha> with the specified \<tags>.
182-
Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry.
182+
Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry.
183183

184184
options:
185185
| name | type | required | default |

resources/scripts/apidocs.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def print_cmd(cmd, super=""):
2929
format_default_value(p["default"], p["type"]["param_type"]),
3030
]
3131
for p in cmd["params"]
32-
if p["name"] != "help"
32+
if p["name"] != "help" and p["name"] != "unknown_args"
3333
]
3434
doc += tabulate(data, headers=headers, tablefmt="github")
3535
doc += "\n\n"

0 commit comments

Comments
 (0)