Propose an update to data-tests.md

dbt-labs / docs.getdbt.com

The code behind docs.getdbt.com

https://docs.getdbt.com/

Apache License 2.0

118 stars 929 forks source link

Closed siljamardla closed 3 months ago

siljamardla commented 4 months ago

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.

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 18, 2024 8:41am

mirnawong1 commented 3 months ago

hey @siljamardla , thanks for opening this pr up! i'm working with the team internally to chat about this further. will revert back!

vercel[bot] commented 3 months ago

@mirnawong1 is attempting to deploy a commit to the dbt-labs Team on Vercel.

A member of the Team first needs to authorize it.