Updated singular tests section to show they can now be documented #6147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
mirnawong1
reviewed
Sep 25, 2024
mirnawong1
approved these changes
Sep 25, 2024
There was a problem hiding this comment.
lgtm, thanks @nataliefiann ! note, i would recommend writing 'Resolves # issue_number' in the pr description. this will automatically close the related issue once the pr is merged. in this case, the issue is #6132
Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
graciegoheen
requested changes
Sep 30, 2024
There was a problem hiding this comment.
Just a heads up - we had to rollback this change. Kshitij is working on a fix, but we should hold off on merging this until that is complete.
See -> dbt-labs/dbt-core#9005
|
Log: moving this blocked in Kanban until status update from engineering |
dbeatty10
reviewed
Sep 30, 2024
dbeatty10
reviewed
Sep 30, 2024
…ning in dbt v1.9, so add a tab with a code example
github-actions
bot
added
size: medium
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
reviewed
Oct 1, 2024
mirnawong1
approved these changes
Oct 1, 2024
There was a problem hiding this comment.
lgtm and i think it's good to merge since PR 10792 has been merged @dbeatty10
|
Closed off as Core project has been paused |
|
Moved to #6191 |
4 tasks
dbeatty10
added a commit
that referenced
this pull request
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 - [`description`](https://docs-getdbt-com-git-dbeatty-6132-docs-dbt-labs.vercel.app/reference/resource-properties/description) - [`docs-paths`](https://docs-getdbt-com-git-dbeatty-6132-docs-dbt-labs.vercel.app/reference/project-configs/docs-paths) - [documentation placement](https://docs-getdbt-com-git-dbeatty-6132-docs-dbt-labs.vercel.app/docs/build/documentation#placement) ### 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 - [x] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [x] Wait until dbt-labs/dbt-core#10792 is merged - [x] Add a note to the prerelease version [Migration Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade) --------- Co-authored-by: Natalie Fiann <Natalie.Fiann@dbtlabs.com> Co-authored-by: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #6132
What are you changing in this pull request and why?
The
descriptionproperty is available for singular data tests beginning in dbt v1.9, and this PR highlights how singular tests can now be documented.🎩 Previews
descriptiondocs-pathsChecklist