Skip to content

Commit

Permalink
🔨 add comment explaining LinkedIndicators
Browse files Browse the repository at this point in the history
  • Loading branch information
ikesau committed Feb 15, 2024
1 parent f75ea15 commit 7325be4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/@ourworldindata/types/src/gdocTypes/Gdoc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ export interface LinkedChart {
indicatorId?: number // in case of a datapage
}

/**
* A linked indicator is derived from a linked grapher's config (see: getVariableOfDatapageIfApplicable)
* e.g. https://ourworldindata.org/grapher/tomato-production -> config for grapher with { slug: "tomato-production" } -> indicator metadata
* currently we only attach a small amount of metadata that we need for key-indicator blocks.
* In the future we might want to attach more metadata, e.g. the indicator's description, source, etc
*/
export interface LinkedIndicator {
id: number
title: string
Expand Down

0 comments on commit 7325be4

Please sign in to comment.