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"