[Core] Explain warn_error_options
vs. warn_error
#5629
Labels
content
Improvements or additions to content
dbt Core
The changes proposed in this issue relate to dbt Core
size: medium
This change will take up to a week to address
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_ERROR
andWARN_ERROR_OPTIONS
and when to use each. Also in communicating that they are mutually exclusive (but very similar).A few suggestions:
warn_error
can be converted towarn_error_options
-- we should give an example of this!warn_error
andwarn_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_options
instead ofwarn_error
?!warn_error
just shorthand / a special case ofwarn_error_options
where nothing is silenced and everything is an error.Enhancement idea for dbt-core: instead of making
warn_error
andwarn_error_options
mutually exclusive, just favorwarn_error_options
overwarn_error
whenever both are provided.Reviewers/Stakeholders/SMEs
.
Related GitHub issues
dbt-labs/dbt-core#10274 (comment)
Additional information
No response
The text was updated successfully, but these errors were encountered: