Skip to content

Commit

Permalink
Update data test descriptions (#6307)
Browse files Browse the repository at this point in the history
## 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](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
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](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.
- [ ] 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."
<!--
PRE-RELEASE VERSION OF dbt (if so, uncomment):
- [ ] 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)
-->
<!-- 
ADDING OR REMOVING PAGES (if so, uncomment):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
-->

<!-- vercel-deployment-preview -->
---
🚀 Deployment available! Here are the direct links to the updated files:


-
https://docs-getdbt-com-git-test-description-dbt-labs.vercel.app/reference/resource-properties/description

<!-- end-vercel-deployment-preview -->

---------

Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
  • Loading branch information
matthewshaver and mirnawong1 authored Oct 24, 2024
1 parent 51639f2 commit 24107bb
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions website/docs/reference/resource-properties/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: "This guide explains how to use the description key to add YAML des
{ label: 'Snapshots', value: 'snapshots', },
{ label: 'Analyses', value: 'analyses', },
{ label: 'Macros', value: 'macros', },
{ label: 'Singular data tests', value: 'singular_data_tests', },
{ label: 'Data tests', value: 'data_tests', },
]
}>
<TabItem value="models">
Expand Down Expand Up @@ -146,17 +146,17 @@ macros:

</TabItem>

<TabItem value="singular_data_tests">
<TabItem value="data_tests">

<VersionBlock firstVersion="1.9">

<File name='tests/singular/schema.yml'>
<File name='tests/schema.yml'>

```yml
version: 2

data_tests:
- name: singular_data_test_name
- name: data_test_name
description: markdown_string

```
Expand All @@ -167,13 +167,12 @@ data_tests:

<VersionBlock lastVersion="1.8">

The `description` property is available for singular data tests beginning in dbt v1.9.
The `description` property is available for generic and singular data tests beginning in dbt v1.9.

</VersionBlock>

</TabItem>


</Tabs>

## Definition
Expand Down

0 comments on commit 24107bb

Please sign in to comment.