Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add column documentation test(s) #492

Open
shah204 opened this issue Sep 10, 2024 · 3 comments
Open

Add column documentation test(s) #492

shah204 opened this issue Sep 10, 2024 · 3 comments
Labels
enhancement New feature or request triage

Comments

@shah204
Copy link

shah204 commented Sep 10, 2024

Describe the feature

Add column documentation test(s) - # of models without full column documentation, and/or a column documentation coverage test that can be configured.

Describe alternatives you've considered

  • of models without full column documentation

  • and/or a column documentation coverage test that can be configured.

Additional context

n/a

Who will this benefit?

dbt projects looking to heavily enforce documentation as part of the development pipeline (us!)

Are you interested in contributing this feature?

Yes - I've never done so before but would love to try 😄

@shah204 shah204 added enhancement New feature or request triage labels Sep 10, 2024
@b-per
Copy link
Collaborator

b-per commented Sep 11, 2024

Hi!

We could somehow add this feature, but it might not be exactly what you are after.

The package only checks the columns that are added manually in the YAML files, NOT all the columns of a given model based on its SQL (e.g. not the list of columns you get in catalog.json after a dbt docs generate).

We have a callout in the docs here.

@dylanvanw
Copy link

Is there no way to also test column documentation for the given model based in its SQL?

That would be a very useful feature for this package.

@b-per
Copy link
Collaborator

b-per commented Nov 4, 2024

No, as mentioned above, it is not possible today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage
Projects
None yet
Development

No branches or pull requests

3 participants