Skip to content

Commit 3fefe5f

Browse files
committed
docs: fix two stale-symbol doc/comment strings (#5132, #5139)
- GanttViewMode JSDoc undercounted its granularities at four; the type, VIEW_MODES, NOMINAL_DAYS, the column builder, the toolbar and the header-band logic all honor a fifth, 'year'. One word. - DOC_TYPE_EXEMPTIONS reason strings for plugin-report.mdx cited ReportInput, retired from @objectstack/spec's export surface at rc.6. Renamed to the live member, ReportSchema.type; the exemptions themselves (matrix/joined) are untouched. No behavior change in either file.
1 parent 232f61a commit 3fefe5f

3 files changed

Lines changed: 14 additions & 3 deletions

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
'@object-ui/plugin-gantt': patch
3+
---
4+
5+
Fix the `GanttViewMode` JSDoc to name all five granularities (objectui#5132).
6+
7+
The comment above `export type GanttViewMode` said "one column per day, week,
8+
month, or quarter" while the type itself, `VIEW_MODES`, `NOMINAL_DAYS`
9+
(`year: 365.25`), the column builder, the toolbar and the header-band logic
10+
have honored a fifth member, `'year'`, all along — `'year'` was fully live,
11+
just undocumented. Doc-only change, no behavior difference.

‎packages/plugin-gantt/src/GanttView.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ export interface GanttTask {
193193
hasOwnDates?: boolean
194194
}
195195

196-
/** Timeline granularity — one column per day, week, month, or quarter. */
196+
/** Timeline granularity — one column per day, week, month, quarter, or year. */
197197
export type GanttViewMode = 'day' | 'week' | 'month' | 'quarter' | 'year';
198198

199199
const VIEW_MODES: GanttViewMode[] = ['day', 'week', 'month', 'quarter', 'year'];

‎scripts/check-doc-component-types.mjs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,8 @@ const DOC_TYPE_EXEMPTIONS = {
326326
'vocabulary (`SelectionConfigSchema`, @objectstack/spec/ui), not a node type.',
327327
},
328328
'content/docs/plugins/plugin-report.mdx': {
329-
matrix: 'ReportInput kind — a report definition\'s shape, sibling of `joined` / `summary`.',
330-
joined: 'ReportInput kind — a report definition\'s shape, sibling of `matrix` / `summary`.',
329+
matrix: 'ReportSchema.type kind — a report definition\'s shape, sibling of `joined` / `summary`.',
330+
joined: 'ReportSchema.type kind — a report definition\'s shape, sibling of `matrix` / `summary`.',
331331
},
332332
'content/docs/utilities/runner.mdx': {
333333
'my-component':

0 commit comments

Comments
 (0)