From 24107bb32a2bd07781317d2720de92649426d215 Mon Sep 17 00:00:00 2001
From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Date: Thu, 24 Oct 2024 10:18:29 -0400
Subject: [PATCH] Update data test descriptions (#6307)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
## What are you changing in this pull request and why?
Generic Test descriptions can now be documented
Closes https://github.com/dbt-labs/docs.getdbt.com/issues/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."
---
🚀 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
---------
Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
---
.../docs/reference/resource-properties/description.md | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/website/docs/reference/resource-properties/description.md b/website/docs/reference/resource-properties/description.md
index 6f32f75efa4..cf7b2b29a5a 100644
--- a/website/docs/reference/resource-properties/description.md
+++ b/website/docs/reference/resource-properties/description.md
@@ -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', },
]
}>
@@ -146,17 +146,17 @@ macros:
-
+
-
+
```yml
version: 2
data_tests:
- - name: singular_data_test_name
+ - name: data_test_name
description: markdown_string
```
@@ -167,13 +167,12 @@ data_tests:
-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.
-
## Definition