docs(vx): state which inspection commands support --json - #9638
docs(vx): state which inspection commands support --json#9638jackylee-ch wants to merge 1 commit into
Conversation
The sentence claimed all inspection commands take --json. SegmentsArgs has no such field and exec_segments serializes unconditionally, so vx segments rejects the flag while always printing JSON; vx tree array declares the flag and then binds it to _json, printing a human tree and exiting 0. Only vx inspect and vx tree layout honour it. Wiring the flag into the other two changes CLI output, so this only corrects the claim. Also lists query and segments in the vx README, which named four of the six subcommands. Signed-off-by: jackylee <qcsd2011@gmail.com>
Merging this PR will regress 1 benchmark
|
| Mode | Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|---|
| ❌ | WallTime | arrow_checked_add_u32_avx2[16384] |
17.7 µs | 21.3 µs | -16.76% |
| ⚡ | WallTime | arrow_checked_add_u32_avx512[16384] |
21.3 µs | 17.6 µs | +20.73% |
| ⚡ | Simulation | take[duplicates/repeated/primitive/nonnull/chunks=16/indices=1000] |
245 µs | 207 µs | +18.39% |
| ⚡ | WallTime | words_gather_scalar_avx2[65536] |
9.5 µs | 8.2 µs | +14.77% |
| ⚡ | WallTime | mul_u32_nonnull_avx512 |
6.3 µs | 5.7 µs | +10.73% |
Tip
Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.
Comparing jackylee-ch:vx-json-docs (2466e23) with develop (ee1ac25)
Footnotes
-
106 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
-
4 benchmarks were run, but are now archived. If they were deleted in another branch, consider rebasing to remove them from the report. Instead if they were added back, click here to restore them. ↩
query.mdsaid all inspection commands support--json.vx segmentshas no such flag (it alwaysprints JSON) and
vx tree arrayaccepts it then prints a human tree, so a script trusting it breakseither way. Wiring
vx tree arraychanges CLI output, so that is left for an issue.Also adds
queryandsegmentsto thevxREADME, which listed four of six subcommands.Tests
make -C docs htmlsucceeds under--fail-on-warning, same warning count as develop.AI assistance
Written with agentic AI assistance; I read each command's argument struct first.