We can do a better job of clearly communicating the differences between WARN_ERROR and WARN_ERROR_OPTIONS and when to use each. Also in communicating that they are mutually exclusive (but very similar).
A few suggestions:
It would have helped me if this were much earlier in the page:
These two are equivalent and show how warn_error can be converted to warn_error_options -- we should give an example of this!
dbt --warn-error test
dbt --warn-error-options '{"error": "all"}' test
Explain the trade-offs between warn_error and warn_error_options. The former is shorter to write (especially as a CLI arg) while the latter is very verbose but allows for silencing warnings you want to ignore.
Maybe we suggest always using warn_error_options instead of warn_error?!
Alternatively, consider warn_error just shorthand / a special case of warn_error_options where nothing is silenced and everything is an error.
Enhancement idea for dbt-core: instead of making warn_error and warn_error_options mutually exclusive, just favor warn_error_options over warn_error whenever both are provided.
Link to the page(s) on docs.getdbt.com requiring updates
https://docs.getdbt.com/reference/global-configs/warnings
Tell us more about this update
We can do a better job of clearly communicating the differences between
WARN_ERRORandWARN_ERROR_OPTIONSand when to use each. Also in communicating that they are mutually exclusive (but very similar).A few suggestions:
warn_errorcan be converted towarn_error_options-- we should give an example of this!warn_errorandwarn_error_options. The former is shorter to write (especially as a CLI arg) while the latter is very verbose but allows for silencing warnings you want to ignore.warn_error_optionsinstead ofwarn_error?!warn_errorjust shorthand / a special case ofwarn_error_optionswhere nothing is silenced and everything is an error.Enhancement idea for dbt-core: instead of making
warn_errorandwarn_error_optionsmutually exclusive, just favorwarn_error_optionsoverwarn_errorwhenever both are provided.Reviewers/Stakeholders/SMEs
.
Related GitHub issues
https://github.com/dbt-labs/dbt-core/issues/10274#issuecomment-2155582205
Additional information
No response