Skip to content

Commit

Permalink
chore(readme): add limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
fernandobrito authored Oct 9, 2023
1 parent f604042 commit 9576272
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/dbttoolkit/documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Propagates dbt documentation for columns that are documented and have the same name in downstream dependencies.

> This project is in an ALPHA stage. Internal and external APIs might change between minor versions. This module has only been tested against Snowflake.
> Example: A dbt model `user` has a column called `name`, which is documented. Another dbt model `user_stats`
> depends on `user` and also has a column called `name`, which is not documented. This automation will
> propagate (i.e., "pass along") the documentation from `user.name` to `user_stats.name`.
Expand Down

0 comments on commit 9576272

Please sign in to comment.