Skip to content

Comments

Add description to docs for proximity views #958

Open
Damonamajor wants to merge 7 commits intomasterfrom
935-add-description-to-docs-for-proximity-views
Open

Add description to docs for proximity views #958
Damonamajor wants to merge 7 commits intomasterfrom
935-add-description-to-docs-for-proximity-views

Conversation

@Damonamajor
Copy link
Contributor

@Damonamajor Damonamajor commented Dec 30, 2025

Quick fix to add columns to the yaml file to produce the docs for missing proximity views.

@Damonamajor Damonamajor linked an issue Dec 30, 2025 that may be closed by this pull request
@Damonamajor Damonamajor changed the title add underscore Add "description" to docs for proximity views Jan 8, 2026
@Damonamajor Damonamajor changed the title Add "description" to docs for proximity views Add description to docs for proximity views Jan 8, 2026
@Damonamajor Damonamajor self-assigned this Jan 8, 2026
@Damonamajor Damonamajor marked this pull request as ready for review January 8, 2026 23:12
@Damonamajor Damonamajor requested a review from a team as a code owner January 8, 2026 23:12
Copy link
Member

@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.

A few small changes to make sure this is all buttoned up!

Comment on lines 820 to 821
- name: nearest_university_gnis_code
description: '{{ doc("column_nearest_university_gnis_code") }}'
Copy link
Member

Choose a reason for hiding this comment

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

[Suggestion, optional] As long as we're cleaning up these docs, I figure we might as well remove this column definition, since it doesn't seem to be part of either vw_pin10_proximity or vw_pin10_proximity_fill anymore.

Comment on lines +634 to +641
- name: airport_data_year
description: '{{ doc("column_airport_data_year") }}'
- name: airport_dnl_total
description: '{{ doc("column_airport_dnl_total") }}'
- name: airport_midway_dist_ft
description: '{{ doc("column_airport_midway_dist_ft") }}'
- name: airport_ohare_dist_ft
description: '{{ doc("column_airport_ohare_dist_ft") }}'
Copy link
Member

Choose a reason for hiding this comment

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

[Nitpick, required] It looks like these fields are defined in the vw_pin10_proximity_fill query:

dist_pin_to_airport.airport_ohare_dist_ft,
dist_pin_to_airport.airport_midway_dist_ft,
dist_pin_to_airport.airport_dnl_total,
dist_pin_to_airport.airport_data_year,

But they're not defined in vw_pin10_proximity:

dist_pin_to_airport.airport_dnl_total,

That means they end up with blank types in the vw_pin10_proximity docs, since those fields are not present in the table, meaning dbt can't infer types for them:

Image

Maybe @wrridgeway knows why these airport metadata fields are missing from vw_pin10_proximity? If there's no good reason for the discrepancy, then the easiest fix here should just be to add these metadata fields to the vw_pin10_proximity query, which will automatically populate their data types in the dbt docs.

Comment on lines +790 to +791
- name: nearest_road_highway_data_year
description: '{{ doc("shared_column_data_year") }}'
Copy link
Member

Choose a reason for hiding this comment

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

[Nitpick, required] Similar to above, this field is defined in vw_pin10_proximity:

dist_pin_to_road_highway.nearest_road_highway_data_year,

But it's missing from vw_pin10_proximity_fill:

dist_pin_to_road_highway.nearest_road_highway_name,
dist_pin_to_road_highway.nearest_road_highway_dist_ft,
dist_pin_to_road_highway.nearest_road_highway_daily_traffic,
dist_pin_to_road_highway.nearest_road_highway_speed_limit,
dist_pin_to_road_highway.nearest_road_highway_surface_type,
dist_pin_to_road_highway.nearest_road_highway_lanes,

Which leads to an empty data type in the docs:

Image

@wrridgeway Same as above: Are we good to add this data_year column to vw_pin10_proximity so that it matches vw_pin10_proximity_fill?

Comment on lines 688 to 691
- name: nearest_grocery_store_name
description: '{{ doc("column_nearest_grocery_store_name") }}'
- name: nearest_grocery_store_name
description: '{{ doc("column_nearest_grocery_store_name") }}'
Copy link
Member

Choose a reason for hiding this comment

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

[Nitpick, required] These two duplicate rows, plus the absence of a description for nearest_grocery_store_data_year in the docs for both proximity.vw_pin10_proximity* tables, make me wonder if perhaps the second entry here is a typo, and we meant to document data_year?

Image

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.

Add "description" to docs for proximity views

2 participants