Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Singular data tests can now be documented (#6191)
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>
- Loading branch information