Two small gaps remain in docs/CATALOG.md: it does not explain a real
curate flag, and it has no troubleshooting entry for a common catalog-root
mistake.
Current behavior
curate --sql-file is undocumented
The positional SQL argument and --sql-file flag are defined at
src/hflow/cli.py:81-90. Passing both or neither prints
curate: pass exactly one of a SQL string or --sql-file and returns 2 at
src/hflow/cli.py:676-679.
The command-line example at docs/CATALOG.md:80-85 shows only inline SQL.
Meanwhile, examples/egocentric/README.md:79-83 uses --sql-file, so a reader
can encounter the flag in an example before the reference explains it.
Document --sql-file and the exactly-one rule in the command-line section of
docs/CATALOG.md.
The catalog-root error has no troubleshooting entry
src/hflow/curation.py:136-143 raises <location> is not a catalog root when
--catalog points at a data root instead of the catalog created beneath it.
Add a short troubleshooting entry explaining that the command expects the
catalog location, commonly <data_root>/catalog, rather than <data_root>.
Pattern to copy
Use the existing command-line block at docs/CATALOG.md:80-85 and the concise
troubleshooting style of the "Port 8080 is taken" entry at
docs/RUNTIME.md:407-412.
Definition of done
docs/CATALOG.md documents --sql-file and the exactly-one rule.
docs/CATALOG.md explains what is not a catalog root means and what path to
pass instead.
Validation
lychee --no-progress --include-fragments \
--exclude '^https://github\.com/Hebbian-Robotics/hflow/(issues|security/advisories/new)$' \
--exclude-path references/mcap-spec.md \
--exclude-path references/foxglove-CompressedVideo.proto .
Two small gaps remain in
docs/CATALOG.md: it does not explain a realcurateflag, and it has no troubleshooting entry for a common catalog-rootmistake.
Current behavior
curate --sql-fileis undocumentedThe positional SQL argument and
--sql-fileflag are defined atsrc/hflow/cli.py:81-90. Passing both or neither printscurate: pass exactly one of a SQL string or --sql-fileand returns 2 atsrc/hflow/cli.py:676-679.The command-line example at
docs/CATALOG.md:80-85shows only inline SQL.Meanwhile,
examples/egocentric/README.md:79-83uses--sql-file, so a readercan encounter the flag in an example before the reference explains it.
Document
--sql-fileand the exactly-one rule in the command-line section ofdocs/CATALOG.md.The catalog-root error has no troubleshooting entry
src/hflow/curation.py:136-143raises<location> is not a catalog rootwhen--catalogpoints at a data root instead of the catalog created beneath it.Add a short troubleshooting entry explaining that the command expects the
catalog location, commonly
<data_root>/catalog, rather than<data_root>.Pattern to copy
Use the existing command-line block at
docs/CATALOG.md:80-85and the concisetroubleshooting style of the "Port 8080 is taken" entry at
docs/RUNTIME.md:407-412.Definition of done
docs/CATALOG.mddocuments--sql-fileand the exactly-one rule.docs/CATALOG.mdexplains whatis not a catalog rootmeans and what path topass instead.
Validation