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

Singular data tests can now be documented #6191

Merged
merged 27 commits into from
Oct 1, 2024
Merged

Conversation

dbeatty10
Copy link
Contributor

@dbeatty10 dbeatty10 commented Oct 1, 2024

Resolves #6132
Originally #6147

What are you changing in this pull request and why?

The description property is available for singular data tests beginning in dbt v1.9, and this PR highlights how singular tests can now be documented.

🎩 Previews

Additional information

Opened #6193 since we don't have documentation how to add a description for the Jinja macro associated with custom generic tests. This follow-up will allow us to consider the description of both generic and singular data tests in context of each other.

Checklist

nataliefiann and others added 22 commits September 25, 2024 13:46
Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
…ning in dbt v1.9, so add a tab with a code example
Copy link

vercel bot commented Oct 1, 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 1, 2024 3:45pm

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address labels Oct 1, 2024
@dbeatty10 dbeatty10 marked this pull request as ready for review October 1, 2024 15:16
@dbeatty10 dbeatty10 requested a review from a team as a code owner October 1, 2024 15:16
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.

small tweak!

@dbeatty10 dbeatty10 enabled auto-merge (squash) October 1, 2024 15:41
@dbeatty10 dbeatty10 merged commit 2d9838c into current Oct 1, 2024
10 checks passed
@dbeatty10 dbeatty10 deleted the dbeatty/6132-docs branch October 1, 2024 15:45
@graciegoheen
Copy link
Collaborator

graciegoheen commented Oct 2, 2024

@dbeatty10 @mirnawong1 I'm realizing this doesn't have a release note - should we add one?

@mirnawong1
Copy link
Contributor

good point and have created a release note PR here: #6227

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 size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Core] Singular data tests can now be documented
4 participants