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

Clarify ways of defining generic tests (macros or test paths) #6697

Open
1 task done
mirnawong1 opened this issue Dec 20, 2024 · 0 comments
Open
1 task done

Clarify ways of defining generic tests (macros or test paths) #6697

mirnawong1 opened this issue Dec 20, 2024 · 0 comments
Labels
community Contributions from the dbt community content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: small This change will take 1 to 2 days to address

Comments

@mirnawong1
Copy link
Contributor

mirnawong1 commented Dec 20, 2024

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/best-practices/writing-custom-generic-tests

What part(s) of the page would you like to see updated?

In the dbt community slack, a community member raised that we configure generic tests using macro code snippets in this article, however we miss explaining why there are two ways of configure tests, the difference between them, and when to use which one.

We can maybe use a table to convey this and as DX for help.

I liked the docs for tests and generic tests, but got confused by the external links because they use macros instead of the test keyword:
https://docs.getdbt.com/best-practices/writing-custom-generic-tests
I think it would be helpful to add a paragraph about why there are two ways of doing the same thing, how they differ and which to use right before the links or incorporating the linked examples in the documentation in a good way.

Additional information

No response

@mirnawong1 mirnawong1 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: small This change will take 1 to 2 days to address community Contributions from the dbt community labels Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Contributions from the dbt community content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear size: small This change will take 1 to 2 days to address
Projects
None yet
Development

No branches or pull requests

1 participant