Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core] Explain warn_error_options vs. warn_error #5629

Open
dbeatty10 opened this issue Jun 7, 2024 · 0 comments
Open

[Core] Explain warn_error_options vs. warn_error #5629

dbeatty10 opened this issue Jun 7, 2024 · 0 comments
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

Comments

@dbeatty10
Copy link
Contributor

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 and WARN_ERROR_OPTIONS and when to use each. Also in communicating that they are mutually exclusive (but very similar).

A few suggestions:

  1. It would have helped me if this were much earlier in the page:
    image
  2. 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
  1. 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.
  2. Maybe we suggest always using warn_error_options instead of warn_error?!
  3. 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.

Reviewers/Stakeholders/SMEs

.

Related GitHub issues

dbt-labs/dbt-core#10274 (comment)

Additional information

No response

@dbeatty10 dbeatty10 added content Improvements or additions to content dbt Core The changes proposed in this issue relate to dbt Core labels Jun 7, 2024
@nataliefiann nataliefiann added the size: medium This change will take up to a week to address label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants