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 shared / updated column documentation to default views #168

Merged
merged 57 commits into from
Oct 25, 2023

Conversation

dfsnow
Copy link
Member

@dfsnow dfsnow commented Oct 18, 2023

This PR adds column definitions/descriptions to almost every variable inside the default.* views. It defines almost all the descriptions in a shared markdown file (shared_columns.md), since many of the views share the same fields.

Upcoming PRs will:

  • Update the column definitions in upstream tables using shared_columns.md, where appropriate
  • Define column definitions for the proximity and location views

@dfsnow dfsnow requested a review from a team as a code owner October 18, 2023 15:29
@dfsnow dfsnow marked this pull request as draft October 18, 2023 15:29
Copy link
Contributor

@jeancochrane jeancochrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EDIT: Oops, I reviewed prematurely 🙈

@dfsnow dfsnow changed the title Add shared / updated column documentation Add shared / updated column documentation to default views Oct 24, 2023
@dfsnow dfsnow marked this pull request as ready for review October 24, 2023 22:02
@dfsnow
Copy link
Member Author

dfsnow commented Oct 24, 2023

@jeancochrane Can you review for implementation details + general overview of the columns?

@wrridgeway Can you review for correctness of the column descriptions?

I apologize in advance for the size of this PR.

Copy link
Contributor

@jeancochrane jeancochrane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implementation looks great to me!

dbt/models/default/docs.md Show resolved Hide resolved
dbt/models/default/schema/default.vw_pin_condo_char.yml Outdated Show resolved Hide resolved
Co-authored-by: Jean Cochrane <jeancochrane@users.noreply.github.com>
Copy link
Member

@wrridgeway wrridgeway left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💖

dbt/models/shared_columns.md Outdated Show resolved Hide resolved
units of work and analysis for the Assessor's Office. Township boundaries are
coincident with triads (triads are made up of townships). Note that townships
can also be units of local government, with their own boards and taxing
authority. Townships in the City of Chicago are effectively vestigial
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spicy

dbt/models/shared_columns.md Outdated Show resolved Hide resolved
dbt/models/shared_columns.md Outdated Show resolved Hide resolved
dbt/models/shared_columns.md Outdated Show resolved Hide resolved
dbt/models/default/schema/default.vw_pin_condo_char.yml Outdated Show resolved Hide resolved
dbt/models/default/schema/default.vw_pin_condo_char.yml Outdated Show resolved Hide resolved
dbt/models/default/schema/default.vw_pin_sale.yml Outdated Show resolved Hide resolved
dfsnow and others added 7 commits October 25, 2023 12:04
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
Co-authored-by: William Ridgeway <10358980+wrridgeway@users.noreply.github.com>
@dfsnow dfsnow merged commit 37d202f into master Oct 25, 2023
7 checks passed
@dfsnow dfsnow deleted the dansnow/add-shared-column-docs branch October 25, 2023 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants