Skip to content

Core: Clean up JSDoc#35008

Merged
Sidnioulz merged 1 commit into
nextfrom
clean-up-jsdoc
Jun 4, 2026
Merged

Core: Clean up JSDoc#35008
Sidnioulz merged 1 commit into
nextfrom
clean-up-jsdoc

Conversation

@Sidnioulz

@Sidnioulz Sidnioulz commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

ø

Manual testing

Go wherever you found this screenshot and check it now says default true.

image

Summary by CodeRabbit

  • Documentation
    • Updated feature flag documentation to reflect the current default behavior configuration.

@Sidnioulz Sidnioulz requested a review from yannbf June 1, 2026 07:45
Copilot AI review requested due to automatic review settings June 1, 2026 07:45
@Sidnioulz Sidnioulz added documentation ci:normal Run our default set of CI jobs (choose this for most PRs). labels Jun 1, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates core type definitions’ JSDoc to reflect that the features.changeDetection flag now defaults to enabled, aligning the public config docs with the actual preset defaults.

Changes:

  • Update StorybookConfigRaw.features.changeDetection JSDoc @default from false to true
  • Remove stale TODO about enabling change detection before a future release

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 56d00dcd-51a1-4030-ad19-117a6bc3bd40

📥 Commits

Reviewing files that changed from the base of the PR and between d6ce689 and 45fedc4.

📒 Files selected for processing (1)
  • code/core/src/types/modules/core-common.ts

📝 Walkthrough

Walkthrough

This PR updates the JSDoc documentation for the changeDetection feature flag in the Storybook configuration types. The default value annotation is changed from @default false (previously marked with a TODO) to @default true to reflect the current behavior.

Changes

Feature flag documentation

Layer / File(s) Summary
changeDetection default documentation
code/core/src/types/modules/core-common.ts
JSDoc comment for the changeDetection feature flag in StorybookConfigRaw['features'] is updated to document @default true instead of @default false with a TODO note.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands and usage tips.

@yannbf yannbf left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Sidnioulz Sidnioulz merged commit 7f1fad8 into next Jun 4, 2026
144 of 148 checks passed
@Sidnioulz Sidnioulz deleted the clean-up-jsdoc branch June 4, 2026 12:43
@github-actions github-actions Bot mentioned this pull request Jun 4, 2026
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:normal Run our default set of CI jobs (choose this for most PRs). documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants