-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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 a "docs" field to models (#1671) #2107
Conversation
ae3ef19
to
997e698
Compare
@beckjake @drewbanin just curious if you saw #1671 (comment) -- considerations for forward compatibility with potential future doc configuration features |
@mike-weinberg I didn't notice it, but docs:
show: lineage or docs:
show:
- lineage or whatever else we want to support. So I guess I feel pretty good about forwards compatibility, unless there's something I'm missing? But of course I will defer to drew on this - I don't have any strong feelings on the matter, and it's easy enough to change. Edit: Obviously, we'd have to change the code to accept a bool or an enum, but this is a "we could support with this syntax", not a "we will support". |
997e698
to
6abd331
Compare
I'll rebase this - I kind of expected removing |
…oolean "show" which defaults to True. Clean up the contracts tests a bit
6abd331
to
d07f233
Compare
@mike-weinberg let me hit you back in the open issue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM - ship it!
Fixes the dbt-core side of #1671
It's parsed from the "models" block in schema.yml. It contains one field, a bool named "show" which defaults to True.
This has no impact besides adding the field to compiled output, and this PR does not update the docs page to make any use of the field.