FormToggle, ToggleControl: Fix docgen in Storybook #64065
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mirka
added
[Type] Developer Documentation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
tyxla
approved these changes
Jul 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Fixes a documentation regression introduced in #60234 where for
FormToggle/ToggleControl, the JSDocs stopped working (in IntelliSense) and the Storybook docgen could not extract the JSDocs and TypeScript types.Why?
For the docgen in Storybook to work, a ref-forwarded component must have a named export. A contributor passing by would not know this, so if these kinds of regressions happen again we should consider adding an eslint rule. (This is the first regression of this kind I've seen, and I don't expect it to happen a lot.)
Testing Instructions
The Storybook docs for both components should show the main JSDocs, as well as the props table with descriptions (broken docs in trunk for comparison: FormToggle/ToggleControl).
The IntelliSense in your IDE should show the JSDocs for both components.