Skip to content

docs(ingest): name iggy wherever the family lists are spelled - #313

Merged
eddietejeda merged 1 commit into
mainfrom
docs/family-list-consistency
Sep 22, 2026
Merged

eddietejeda merged 1 commit into
mainfrom
docs/family-list-consistency

Conversation

@eddietejeda

Copy link
Copy Markdown
Contributor

Follow-up to the four non-blocking notes on #312: iggy added to the --family help (both commands) and its required-error, to the --dest-table-prefix doc, and to the skill's prefix note; derived dropped from the skill's --stream note since the CLI never exposes it; one overlong string line rewrapped. Tests and the skill gate pass.

The --family help and its error, the --dest-table-prefix doc, and the
skill's prefix note listed the families without iggy, so the CLI's own
help contradicted the skill. The skill's --stream note also named
derived, a family the CLI never exposes. One overlong string line
rewrapped.
@eddietejeda
eddietejeda requested a review from a team as a code owner September 22, 2026 04:21
@eddietejeda
eddietejeda requested review from zfarrell and removed request for a team September 22, 2026 04:21
Comment thread src/commands/ingest.rs
/// Common prefix for the destination tables of a source that lands
/// SEVERAL: SQL --table/--sql, Iceberg, DuckLake, Kafka, REST. Each
/// source table `orders` lands as `<prefix>_orders`.
/// SEVERAL: SQL --table/--sql, Iceberg, DuckLake, Kafka, Iggy, REST.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: one more copy of this same list still omits Iggy (not blocking).

src/client/ingest.rs:167 prints the multi-table family list in the invalid_destination error hint: (SQL --table/--sql, Iceberg, DuckLake, Kafka, REST). That line is outside this diff, so a suggestion block cannot reach it.

A user who passes --dest-table with an Iggy source hits that hint and reads a list that excludes Iggy. The hint then contradicts this --help text and skills/hotdata/SKILL.md:393. Add Iggy after Kafka there for the same reason the other two lists changed.

Comment thread src/commands/ingest.rs
Comment on lines 841 to 846
"nothing to read — pass --table <name> (SQL, Iceberg, DuckLake), --table-path \
<path> (Delta), --topic <name> (Kafka; Iggy as stream/topic), --format with an optional --glob \
(buckets), --sql, --raw-sql, --all, or the whole --selector as JSON. A REST \
<path> (Delta), --topic <name> (Kafka; Iggy as stream/topic), --format with an \
optional --glob (buckets), --sql, --raw-sql, --all, or the whole --selector as \
JSON. A REST \
source is --selector only: its resources carry endpoints, not just names \
('hotdata ingest sources fields rest')"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super nit: the rewrap leaves JSON. A REST as a short stub line (not blocking). Refilling the remaining continuations keeps the literal readable for the next editor.

Suggested change
"nothing to read — pass --table <name> (SQL, Iceberg, DuckLake), --table-path \
<path> (Delta), --topic <name> (Kafka; Iggy as stream/topic), --format with an optional --glob \
(buckets), --sql, --raw-sql, --all, or the whole --selector as JSON. A REST \
<path> (Delta), --topic <name> (Kafka; Iggy as stream/topic), --format with an \
optional --glob (buckets), --sql, --raw-sql, --all, or the whole --selector as \
JSON. A REST \
source is --selector only: its resources carry endpoints, not just names \
('hotdata ingest sources fields rest')"
"nothing to read — pass --table <name> (SQL, Iceberg, DuckLake), --table-path \
<path> (Delta), --topic <name> (Kafka; Iggy as stream/topic), --format with an \
optional --glob (buckets), --sql, --raw-sql, --all, or the whole --selector as \
JSON. A REST source is --selector only: its resources carry endpoints, not just \
names ('hotdata ingest sources fields rest')"

@eddietejeda
eddietejeda merged commit ace9f12 into main Sep 22, 2026
14 checks passed
@eddietejeda
eddietejeda deleted the docs/family-list-consistency branch September 22, 2026 04:25
@codecov

codecov Bot commented Sep 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

1 participant