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.

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 description property page #6733

Merged
merged 11 commits into from
Jan 9, 2025
Merged

update description property page #6733

merged 11 commits into from
Jan 9, 2025

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jan 8, 2025

this pr adds add'l examples to the description property page:

  • data tests: generic and singular
  • unit tests

raised in internal slack

Resolves #6193


🚀 Deployment available! Here are the direct links to the updated files:

@mirnawong1 mirnawong1 requested a review from a team as a code owner January 8, 2025 10:46
Copy link

vercel bot commented Jan 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 9, 2025 4:58pm

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address labels Jan 8, 2025
Copy link
Contributor

@nataliefiann nataliefiann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hiya @mirnawong1

Thanks for creating this! I've approved this for you with one non-blocking suggestion.

Kind Regards
Natalie

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @mirnawong1 I just had some small suggestions, but not editing/merging so you check my logic here in case I missed something.

version: 2

data_tests:
- name: data_test_name
description: markdown_string
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this is necessary but trying to figure out why the text turns blue here and is not respecting color coding.

Suggested change
```

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @runleonarun going to put the backticks back in bc it was rendering weird and the versionblock/tabs markdown was showing up:
Screenshot 2025-01-09 at 09 57 15

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is how it's looking after adding the backticks back in:

Screenshot 2025-01-09 at 10 25 31

Screenshot 2025-01-09 at 10 10 41

website/docs/reference/resource-properties/description.md Outdated Show resolved Hide resolved
website/docs/reference/resource-properties/description.md Outdated Show resolved Hide resolved
mirnawong1 and others added 4 commits January 9, 2025 09:58
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
@mirnawong1
Copy link
Contributor Author

mirnawong1 commented Jan 9, 2025

Hey @mirnawong1 I just had some small suggestions, but not editing/merging so you check my logic here in case I missed something. i also added the global version callout for the exmples sections:

Screenshot 2025-01-09 at 10 23 48

thanks for the review @runleonarun ! made some tweaks and would love a re-review pls!

@dbt-labs dbt-labs deleted a comment from github-actions bot Jan 9, 2025
</File>

</VersionBlock>

<VersionBlock lastVersion="1.8">

The `description` property is available for generic and singular data tests beginning in dbt v1.9.
The `description` property is available for [singular data tests](/docs/build/data-tests#singular-data-tests) or [generic data tests](/docs/build/data-tests#generic-data-tests) beginning in dbt v1.9.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.9'?

columns:
- name: column_name
tests:
- unique
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops I forgot a : in my example. It should be:

models:
  - name: orders
    columns:
      - name: order_id
        tests:
          - unique:
              description: The order_id is unique for every row in the orders model

looking at the PR here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

eek great flag, thanks for sharing the code @graciegoheen !

add missing :
@mirnawong1 mirnawong1 mentioned this pull request Jan 9, 2025
1 task
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 🚢 it!

@runleonarun runleonarun merged commit bb8bc58 into current Jan 9, 2025
8 checks passed
@runleonarun runleonarun deleted the udpate-description branch January 9, 2025 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding a description for singular data tests and custom generic data tests
4 participants