[CT-1766] [DX] Review command + param help text in CLI / top-level API #6546
Closed
Labels
cli
enhancement
New feature or request
paper_cut
A small change that impacts lots of users in their day-to-day
python_api
Issues related to dbtRunner Python entry point
Refinement
Maintainer input needed
Let's give the "help" text defined below another review from a DX (Developer Experience) lens:
Anything marked
TODO
is especially in need, but I think all help text deserves another look-over.This is also our opportunity to remove params / help text that are completely unused or irrelevant. For example,
dbt compile --parse-only
doesn't do anything, and I don't believe it ever has.Context
This is what users will see when running
dbt --help
(invoked as module for now):And it's also what they'll see in our auto-generated "API docs."
The text was updated successfully, but these errors were encountered: