Is it possible to add a description to Singular tests?

Help
,
1

Per topic, is it possible to add descriptions to Singular tests and expose these descriptions to dbt docs?

2

Currently, this is not possible. See more info here:

3

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

4

As of 1.9 (also available in Versionless on Cloud), it’s possible to add descriptions to generic and singular tests:

For a generic test, you add the description inline with the rest of the existing YAML:

# models/staging/whatever.yml

models:
  - name: my_model
    columns:
      - name: delivery_status
        tests:
          - accepted_values:
              values: ['delivered', 'pending', 'failed']
              description: "This test checks whether there are unexpected delivery statuses. If it fails, check with logistics team"

For a singular test, it’s defined in the tests directory:

# tests/my_custom_test.yml

data_tests: 
  - name: my_custom_test
    description: "This test checks whether the rolling average of returns is inside of expected bounds. If it isn't, flag to customer success team"