docs: README's query status exit codes omitted 3 (truncated preview) - #298
Merged
Conversation
The README presents the exit-code set as complete for scripting (0 done / 1 failed / 2 running), but query.rs defines and documents a fourth: EXIT_INCOMPLETE_RESULT = 3, returned when the query succeeded and the printed result is an incomplete/truncated preview. A script treating the listed set as exhaustive would misread 3.
eddietejeda
requested review from
anoop-narang
and removed request for
a team
September 10, 2026 03:05
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Verified the exit code claim against src/commands/query.rs. EXIT_INCOMPLETE_RESULT = 3 (line 57), query status reaches it through poll → print_result → result_exit_code (lines 554, 679-682). The new README wording matches the QueryCommands::Status docstring at lines 13-16.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README accuracy audit against the clap/config source (same flow as hotdata-dev/hotdata-ibis#55).
query statusexit codes: the README listed 0/1/2 as complete, butsrc/commands/query.rsalso defines3(EXIT_INCOMPLETE_RESULT— query succeeded, printed result is a truncated preview). The section is pitched at script authors, so the missing code was a real trap. Added it.Every command-table row, flag rename, env var, config path, and install step verified against source. Not verifiable from the repo: the "~150 API services" count (server-side).