ccao-data / data-architecture

Codebase for CCAO data infrastructure construction and management
https://ccao-data.github.io/data-architecture/
5 stars 3 forks source link

Update test descriptions to use iasWorld column names #354

Closed jeancochrane closed 3 months ago

jeancochrane commented 3 months ago

We often make use of config.description in dbt tests to hint at the underlying meaning of columns with opaque names. These column hints are included as parentheticals that follow the technical name for the column. For example, attic type is the column hint for the attic column in this test:

https://github.com/ccao-data/data-architecture/blob/d7c7fc05df3ea1635b5efbbe593288b7f5a090c6/dbt/models/iasworld/schema/iasworld.dweldat.yml#L73-L75

It would be clearer to end users if these hints used the name of the column as it is displayed in the iasWorld UI, rather than the internal description of the column that we use for our purposes.

This change will be most useful for dweldat tests and tests in the qc schema that refer to the asmt test, but we should audit the rest of the tests as well.