Test Descriptions

[madarez]

Describe the bug

I'm trying to add descriptions to my tests, but whatever I try it won't add descriptions there when I look at it in the dbt doc, and I suppose it's not supported. Can we enable descriptions?

Steps to reproduce

1. create a test file
2. set description

• in a schema.yml or inside the file next to or within configs --> see Screenshots

3. run dbt doc generate and serve
4. select the test from the navigator
5. see the description

Expected results

N/A

Actual results

No description is written there for tests

Screenshots

Here's the yml file I tried settting descriptions for that sits next to the test SQL file:

Here's my attempt with setting it within the test SQL file:

System information

packages:
  - package: dbt-labs/dbt_utils
    version: 1.0.0
  - git: "https://github.com/EqualExperts/dbt-unit-testing"
    revision: v0.2.6
  - package: calogica/dbt_expectations
    version: [">=0.8.0", "<0.9.0"]

Which database are you using dbt with?

• postgres
• redshift
• bigquery
• snowflake
• other (specify: ____________)

The output of dbt --version:

Core:
  - installed: 1.4.1
  - latest:    1.6.3 - Update available!

  Your version of dbt-core is out of date!
  You can find instructions for upgrading here:
  https://docs.getdbt.com/docs/installation

Plugins:
  - snowflake: 1.4.0 - Update available!

  At least one plugin is out of date or incompatible with dbt-core.
  You can find instructions for upgrading here:
  https://docs.getdbt.com/docs/installation

Additional context

I suspect it is not be supported today.

Are you interested in contributing the fix?

Sorry, I can't

[patmaddox]

I came here searching for the same thing, and my research leads me to believe that dbt has no way to set the description in the YAML. I've seen some issues and PRs in dbt-core, but all have led to dead-ends. I suspect that dbt-core is the place for this fix - but that it may be possible to introduce a description key in this library as well.

[github-actions]

This issue has been marked as Stale because it has been open for 180 days with no activity. If you would like the issue to remain open, please comment on the issue or else it will be closed in 7 days.

[github-actions]

Although we are closing this issue as stale, it's not gone forever. Issues can be reopened if there is renewed community interest. Just add a comment to notify the maintainers.

[lawrenceadams]

For anyone who stumbles across this, it's now possible as of 1.9: dbt-labs/dbt-core#9005

(with properties.yml and data_tests attribute)