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

Fixed a mistake in JSDoc #23186

Merged
merged 18 commits into from
Jul 14, 2023
Merged

Fixed a mistake in JSDoc #23186

merged 18 commits into from
Jul 14, 2023

Conversation

re-taro
Copy link
Contributor

@re-taro re-taro commented Jun 22, 2023

Closes #23119

What I did

I have corrected the incorrect code example in JSDoc, as noted in the issue above.

How to test

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Create setup file for testing Story with vitest etc.
  3. Make sure there are no errors by writing according to JSDoc.

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@re-taro re-taro changed the title fix(docs): fixed a mistake in JSDoc Fixed a mistake in JSDoc Jun 22, 2023
@re-taro
Copy link
Contributor Author

re-taro commented Jul 11, 2023

@shilman
Sorry to bother you. I know this PR is incredibly simple and could be merged at any time, but it is an important docs mistake to code, so a review would be helpful!

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM!

@kasperpeulen kasperpeulen added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Jul 13, 2023
@kasperpeulen kasperpeulen merged commit 3531eb3 into storybookjs:next Jul 14, 2023
@re-taro re-taro deleted the fix/jsdoc branch July 14, 2023 08:17
storybook-bot pushed a commit that referenced this pull request Jul 14, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
@github-actions github-actions bot mentioned this pull request Jul 14, 2023
16 tasks
storybook-bot pushed a commit that referenced this pull request Jul 15, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 15, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
@github-actions github-actions bot mentioned this pull request Jul 17, 2023
11 tasks
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 17, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
storybook-bot pushed a commit that referenced this pull request Jul 18, 2023
Fixed a mistake in JSDoc

(cherry picked from commit 3531eb3)
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Type Error Occurs in setup.ts When Following JSDoc Example
4 participants