Skip to content

Commit 3952806

Browse files
committed
docs(analytics): name the reference dimension class instead of listing two of its four members
`REFERENCE_VALUE_TYPES` is one class -- `lookup`, `master_detail`, `user`, `tree` -- and all four store a related record's id and resolve to that record's display name. Two authored pages enumerated only `lookup` / `master_detail`, so a reader asking whether a person axis renders a name read "no" off the enumeration. Name the class in both sentences rather than growing the enumeration by two: a prose list that mirrors a `const` is a second copy that drifts the next time the set moves. Claude-Session: https://claude.ai/code/session_017ef78bLdybu3AffehKkhfk Co-authored-by: Claude <noreply@anthropic.com>
1 parent 8fe5cb8 commit 3952806

2 files changed

Lines changed: 7 additions & 4 deletions

File tree

‎content/docs/data-modeling/analytics.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,8 @@ The query result is presentation-ready — authors do not format dimension or
208208
measure values by hand:
209209

210210
- **Dimensions** — a `select` dimension returns its option **label** (not the
211-
stored value), a `lookup` / `master_detail` dimension returns the related
211+
stored value), a **reference** dimension (any field whose stored value is
212+
another record's id, a `user` person axis included) returns the related
212213
record's **display name** (not the FK id), and a `date` dimension with a
213214
`dateGranularity` returns a human bucket label (`month` → `2026-04`,
214215
`quarter` → `2026-Q2`, `year` → `2026`). Unresolved values pass through

‎content/docs/ui/dashboards.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,13 @@ Notes on behaviour:
143143
truncates a reproducible window instead of an arbitrary subset.
144144
- Ordering is applied to the finished grid, so a **derived measure** is a valid
145145
`sortBy` even though no single SQL statement computes it.
146-
- A `sortBy` naming a **select** or **lookup** dimension orders by the
146+
- A `sortBy` naming a **select** or **reference** dimension orders by the
147147
**display label** the rows render (the option label / the related record's
148148
name), not the stored value or foreign-key id — and the label is resolved
149-
before `limit` applies, so a top-N by name truncates the right N. Sorting by
150-
a measure (the common case) involves no label lookup and is unaffected.
149+
before `limit` applies, so a top-N by name truncates the right N.
150+
**Reference** is the whole class of fields whose stored value is another
151+
record's id, so a `user` person axis sorts by name too. Sorting by a measure
152+
(the common case) involves no label lookup and is unaffected.
151153
- A `funnel` with no declared stage order falls back to sorting by value
152154
descending.
153155

0 commit comments

Comments
 (0)