[Core] How to add a description for custom generic tests

[dbeatty10]

Link to the page(s) on docs.getdbt.com requiring updates

https://docs.getdbt.com/best-practices/writing-custom-generic-tests

Tell us more about this update

There are two types of data tests, and users can create custom tests in both types:

• generic
• singular

When creating a custom generic test, many users want to add a description that shows up in the generated docs site.

One user described how to accomplish this goal: dbt-labs/dbt-core#2578 (comment)

e.g., do something like this:

macros/_generic_data_tests.yml or tests/generic/_generic_data_tests.yml (EDIT: the 2nd one didn't work for me)

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`
    arguments:
      - name: model
        type: string
        description: Model Name
      - name: column_name
        type: string
        description: Column name that should not be an empty string

Note: it doesn't strictly need to be named _generic_data_tests.yml; it could be something else like properties.yml.

Reviewers/Stakeholders/SMEs

.

Related GitHub issues

• [spike] Allow generic data tests to be documented dbt-core#2578
• [Bug] Test description empty in manifest.json dbt-core#10272

Additional information

No response