adds description example of core logic for generic test

[mirnawong1]

this pr tries to clarify how to add descriptions to the Jinja macro that provides the core logic of a generic data test.

updates done in the following pages:

• data test configs
• custom tests best practices
• description property page
• data test build page

Resolves #5631

---

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

• https://docs-getdbt-com-git-add-generic-test-macro-dbt-labs.vercel.app/best-practices/custom-generic-tests
• https://docs-getdbt-com-git-add-generic-test-macro-dbt-labs.vercel.app/docs/build/data-tests
• https://docs-getdbt-com-git-add-generic-test-macro-dbt-labs.vercel.app/reference/data-test-configs
• https://docs-getdbt-com-git-add-generic-test-macro-dbt-labs.vercel.app/reference/resource-properties/description

[vercel]

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

Name	Status	Preview	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	Feb 28, 2025 10:02am

[nataliefiann]

Hiya @mirnawong1

Thanks for creating this PR! I've approved this for you. No recommendations or suggestions from me.

Kind Regards
Natalie

[dbeatty10]

Looks good to me!

Note

If the name of the test block is not_empty_string, then the name of the macro to document has test_ added to the front: test_not_empty_string.

So documenting a macro named test_something would be applied to the test definition in tests/generic named something.

Example

For example tests/generic/not_empty_string.sql:

{% test not_empty_string(model, column_name) %}

select {{ column_name }}
from {{ model }}
where {{ column_name }} = ''

{% endtest %}

macros:
  - name: test_not_empty_string
    description: Complementary test to default `not_null` test as it checks that there is not an empty string. It only accepts columns of type string. It is deprecated as this functionality has been included in the custom implementation of `not_null`