Skip to content

docs(vx): state which inspection commands support --json - #9638

Open
jackylee-ch wants to merge 1 commit into
vortex-data:developfrom
jackylee-ch:vx-json-docs
Open

docs(vx): state which inspection commands support --json#9638
jackylee-ch wants to merge 1 commit into
vortex-data:developfrom
jackylee-ch:vx-json-docs

Conversation

@jackylee-ch

@jackylee-ch jackylee-ch commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

query.md said all inspection commands support --json. vx segments has no such flag (it always
prints JSON) and vx tree array accepts it then prints a human tree, so a script trusting it breaks
either way. Wiring vx tree array changes CLI output, so that is left for an issue.

Also adds query and segments to the vx README, which listed four of six subcommands.

Tests

make -C docs html succeeds under --fail-on-warning, same warning count as develop.

AI assistance

Written with agentic AI assistance; I read each command's argument struct first.

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>
@myrrc
myrrc enabled auto-merge (squash) August 26, 2026 11:45
@codspeed-hq

codspeed-hq Bot commented Aug 26, 2026

Copy link
Copy Markdown

Merging this PR will regress 1 benchmark

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 4 improved benchmarks
❌ 1 regressed benchmark
✅ 2107 untouched benchmarks
⏩ 106 skipped benchmarks1
🗄️ 4 archived benchmarks run2

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

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)

Open in CodSpeed

Footnotes

  1. 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.

  2. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants