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

Update data test descriptions #6307

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Update data test descriptions #6307

merged 4 commits into from
Oct 24, 2024

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Oct 17, 2024

What are you changing in this pull request and why?

Generic Test descriptions can now be documented

Closes #6293

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

🚀 Deployment available! Here are the direct links to the updated files:

@matthewshaver matthewshaver requested a review from a team as a code owner October 17, 2024 14:58
@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. Docs team Authored by the Docs team @dbt Labs labels Oct 17, 2024
Copy link

vercel bot commented Oct 17, 2024

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Oct 24, 2024 1:57pm

@github-actions github-actions bot added size: small This change will take 1 to 2 days to address and removed size: x-small This change will take under 3 hours to fix. labels Oct 24, 2024
@matthewshaver matthewshaver changed the title [Draft] Update data test descriptions Update data test descriptions Oct 24, 2024
@mirnawong1
Copy link
Contributor

hey @matthewshaver , do you think we should modify one of the examples under the 'examples' header to include tests?

e.g.

- name: color
  tests:
    - accepted_values:
        values: ['blue', 'green', 'red']
        description: "{{ doc('color_accepted_values') }}"

@mirnawong1
Copy link
Contributor

also it maybe out of scope but would it be a good idea to link to the description property page here?

@matthewshaver
Copy link
Contributor Author

Good questions @mirnawong1 - I only updated to stress all data tests in the description. There was an earlier PR from some others that didn't do it then. Maybe because it would be a lot of version blocking

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you @matthewshaver !

@matthewshaver matthewshaver merged commit 24107bb into current Oct 24, 2024
13 checks passed
@matthewshaver matthewshaver deleted the test-description branch October 24, 2024 14:18
@joellabes
Copy link
Contributor

My vote is to add some examples, even if they're not truly inside of version blocks and just have a comment beside them or something. I was just sharing info on how this worked, and wound up having to backsolve it myself instead of using the docs.

A couple of examples are here if you want to leverage them: https://discourse.getdbt.com/t/is-it-possible-to-add-a-description-to-singular-tests/5472/4

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 Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Core] Allow instances of generic data tests to be documented dbt-core #2578
3 participants