Add dbt documentation to sale.* assets
#202
Conversation
| @@ -14,7 +14,7 @@ models: | |||
| - name: is_multisale | |||
| description: '{{ doc("shared_column_sale_is_multisale") }}' | |||
| - name: is_mydec_date | |||
| description: Indicator for whether or not the observation uses the myDec sale date | |||
| description: Indicator for whether or not the observation uses the MyDec sale date | |||
There was a problem hiding this comment.
Just capitalizing MyDec correctly in all places in the documentation. Didn't want to put it in a separate PR.
| {% enddocs %} | ||
|
|
||
| # group_mean |
There was a problem hiding this comment.
I've added markdown headers to the doc assets just to make them easier to read, navigate, and fold.
| @@ -1,19 +1,67 @@ | |||
| # flag | |||
|
|
|||
| {% docs flag %} | |||
There was a problem hiding this comment.
[Thought, non-blocking] I like the way you've been using prefixes to hint at the purpose of column descriptions, i.e. column_* and shared_column_*. I wonder if that's worth doing for tables, too? E.g. table_flag instead of flag? Views already follow a built-in vw_* naming convention, so it seems like tables are the odd ones out.
There was a problem hiding this comment.
I've already started to do that in the upcoming #203! So we're definitely on the same page.
| - name: foreclosure | ||
| description: '{{ doc("foreclosure") }}' | ||
| tags: | ||
| - load_manual |
There was a problem hiding this comment.
[Question, non-blocking] Do we want docs for sale.foreclosure columns as well?
There was a problem hiding this comment.
Probably, but there are a billion columns and I don't want to add docs for them right now. I added this as a subtask to #201.
This PR adds column documentation to all tables and views in the
saleschema. It also adds top-level documentation to each table/view. Finally, it correctly capitalizes MyDec elsewhere in our dbt documentation.@wagnerlmichael please review this for accuracy.