-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
priority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hourstype:docsDocumentation onlyDocumentation only
Milestone
Description
Description
Sprint 4 shipped two user-facing features without corresponding documentation updates:
--jsonflag (JSON output format (--json) #44 / PR feat: add --json output flag #74) — the flag is implemented and tested, but not documented in README.md or the man page (docs/sql-pipe.1.scd).- Alpine APK packaging (APK package for Alpine Linux #66 / PR feat: add APK package for Alpine Linux to release workflow #75) —
.apkpackages are now built in the release workflow, but README.md has no install instructions for Alpine users.
Acceptance Criteria
- README.md: add
--jsonto the Flags table - README.md: add usage example showing
--jsonoutput - README.md: note that
--jsonis mutually exclusive with--delimiter/--tsv/--header - README.md: add Alpine Linux / APK install section (between RPM and AUR)
-
docs/sql-pipe.1.scd: add--jsonto OPTIONS section -
docs/sql-pipe.1.scd: add example with--json -
docs/sql-pipe.1.scd: document incompatibility with--delimiter/--tsv/--header
Notes
- The
--jsonhelp text inprintUsage()(src/main.zig:99) is already correct — this is docs-only.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
priority:highMust be in the next sprintMust be in the next sprintsize:sSmall — 1 to 4 hoursSmall — 1 to 4 hourstype:docsDocumentation onlyDocumentation only