docs: align README and CLI help with actual command behavior#33
Merged
Conversation
- Regenerate the scan example output to match real program output (heading, --order-by flag, Nullable(...) type wrapper) - Document that scan's --name flag has no effect on output - Note that diff takes <OLD> <NEW> rather than a single <INPUT> - Fix input help strings to mention JSON arrays and stdin, not just NDJSON
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.
Audited the README against the actual CLI source and fixed four inaccuracies. Docs-only — no behavior change. All 26 tests still pass.
Changes
scanexample output (README) — regenerated from realclickforge scan video_events.jsonoutput. Fixed the stale heading (Run with chosen engine:→To generate a migration with the chosen engine, run:), added the--order-byflag the tool actually prints, and corrected the type column to show theNullable(...)wrapper for nullable fields.scan's-n, --nameflag (README) — it's a no-op forscan(output keys off the source filename, never the table name). Description now says so.kafka/scan/tabletake a single<INPUT>whiledifftakes<OLD> <NEW>.cli.rshelp strings — theinputarg help said "NDJSON file (one JSON object per line)", but the code also accepts JSON arrays and stdin (-). Now reads "Path to a JSON array or NDJSON file (or `-` for stdin)", matching the README and reality.