Skip to content

docs: fix two stale-symbol doc/comment strings (GanttViewMode JSDoc, ReportInput exemption reasons)#5331

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.

Sign up for GitHub

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

Merged
os-support-ai merged 1 commit into from
Aug 19, 2026
Merged

docs: fix two stale-symbol doc/comment strings (GanttViewMode JSDoc, ReportInput exemption reasons) #5331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/stale-gantt-viewmode-doc.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@object-ui/plugin-gantt': patch
---

Fix the `GanttViewMode` JSDoc to name all five granularities (objectui#5132).

The comment above `export type GanttViewMode` said "one column per day, week,
month, or quarter" while the type itself, `VIEW_MODES`, `NOMINAL_DAYS`
(`year: 365.25`), the column builder, the toolbar and the header-band logic
have honored a fifth member, `'year'`, all along — `'year'` was fully live,
just undocumented. Doc-only change, no behavior difference.
2 changes: 1 addition & 1 deletion packages/plugin-gantt/src/GanttView.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -193,7 +193,7 @@ export interface GanttTask {
hasOwnDates?: boolean
}

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

const VIEW_MODES: GanttViewMode[] = ['day', 'week', 'month', 'quarter', 'year'];
Expand Down
4 changes: 2 additions & 2 deletions scripts/check-doc-component-types.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -326,8 +326,8 @@ const DOC_TYPE_EXEMPTIONS = {
'vocabulary (`SelectionConfigSchema`, @objectstack/spec/ui), not a node type.',
},
'content/docs/plugins/plugin-report.mdx': {
matrix: 'ReportInput kind — a report definition\'s shape, sibling of `joined` / `summary`.',
joined: 'ReportInput kind — a report definition\'s shape, sibling of `matrix` / `summary`.',
matrix: 'ReportSchema.type kind — a report definition\'s shape, sibling of `joined` / `summary`.',
joined: 'ReportSchema.type kind — a report definition\'s shape, sibling of `matrix` / `summary`.',
},
'content/docs/utilities/runner.mdx': {
'my-component':
Expand Down
Loading