Skip to content
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.

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

Update SelectControl JSDoc #53379

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Conversation

bangank36
Copy link
Contributor

What?

  • Update SelectControl JSDoc comment so it can be parsed properly in storybook

Why?

According to @wordpress/components contributing handbook

On the component's main named export, add a JSDoc comment that includes the main description and the example code snippet from the README (example). At the time of writing, the @example JSDoc keyword is not recognized by StoryBook's docgen, so please avoid using it.

How?

Removing @example keyword and replace with jsx syntax

Testing Instructions

  • Run npm run storybook:dev
  • Navigator to {host}/?path=/docs/components-selectcontrol--default
  • Confirm the JSDoc is parsed properly
Before Storybook VSCode
image image image

Testing Instructions for Keyboard

Screenshots or screencast

@bangank36
Copy link
Contributor Author

Update

I tried to find missing JSDoc and have come up with a list

Components Storybook Source
ItemGroup story source
Navigation story source
NavigatorProvider story source
Spinner story source
Text story source
Theme story source
ToolsPanel story source
TreeSelect story source
UnitControl story source
UseCx story source
View story source

@mirka mirka added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Aug 10, 2023
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

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

Good catch, thanks!

@mirka mirka merged commit 72df33c into WordPress:trunk Aug 10, 2023
50 of 52 checks passed
@github-actions github-actions bot added this to the Gutenberg 16.5 milestone Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants