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.

Sign up for GitHub

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

Update data test descriptions #6307

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Update data test descriptions #6307

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a0e012
[Draft] Update data test descriptions
matthewshaver Oct 17, 2024
6b8fe2e
Editorial changes
matthewshaver Oct 17, 2024
666289c
Updating for all data tests
matthewshaver Oct 24, 2024
a243d12
Merge branch 'current' into test-description
mirnawong1 Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions website/docs/reference/resource-properties/description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
{ 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', },

Check warning on line 16 in website/docs/reference/resource-properties/description.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/reference/resource-properties/description.md#L16 

[custom.Typos] Oops there's a typo -- did you really mean 'data_tests'?
Raw output 
{"message": "[custom.Typos] Oops there's a typo -- did you really mean 'data_tests'? ", "location": {"path": "website/docs/reference/resource-properties/description.md", "range": {"start": {"line": 16, "column": 36}}}, "severity": "WARNING"}
]
}>
<TabItem value="models">
Expand Down Expand Up @@ -146,17 +146,17 @@

</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 @@

<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.

Check warning on line 170 in website/docs/reference/resource-properties/description.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/reference/resource-properties/description.md#L170 

[custom.Typos] Oops there's a typo -- did you really mean 'v1.9'?
Raw output 
{"message": "[custom.Typos] Oops there's a typo -- did you really mean 'v1.9'? ", "location": {"path": "website/docs/reference/resource-properties/description.md", "range": {"start": {"line": 170, "column": 94}}}, "severity": "WARNING"}

</VersionBlock>

</TabItem>


</Tabs>

## Definition
Expand Down
Loading