Propose an update to data-tests.md #5607
Conversation
As surprised as I am, I could not find how to add documentation to tests.
I would assume it would look like this:
```
tests:
- name: some_test_name
description: >
Description of the some_test_name test.
meta:
owner: '@firstname.lastname'
```
but I could not get the description to show up in the automatically generated dbt docs.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
|
hey @siljamardla , thanks for opening this pr up! i'm working with the team internally to chat about this further. will revert back! |
|
@mirnawong1 is attempting to deploy a commit to the dbt-labs Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
hey @siljamardla , thanks so much for opening this pr up and great question! currently, you can’t document your data tests and we have an open issue in dbt core that requests this as well! this is something we want to support eventually but haven’t been able to prioritize yet.
I did add some clarifying language in one of the faqs and linked that faq to data-test page. I'll go ahead and merge this so we can ship something clearer - thank you for opening this up!
As surprised as I am, I could not find how to add documentation to tests.
I would assume it would look like this:
but I could not get the description to show up in the automatically generated dbt docs.