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

Docs: Decorators - Fix snippet syntax #28456

Conversation

ROCKTAKEY
Copy link
Contributor

@ROCKTAKEY ROCKTAKEY commented Jul 4, 2024

What I did

Fix document of decorators, since case default: is not a valid label for switch.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

  • Corrected case default: to default: in switch statements
  • Updated code snippets for Angular, React, Solid, and Vue frameworks

File: docs/_snippets/decorator-parameterized-in-preview.md

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@jonniebigodes jonniebigodes self-assigned this Jul 4, 2024
@jonniebigodes jonniebigodes changed the title docs: case default: is not a valid label for switch Docs: Decorators - Fix snippet syntax Jul 8, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Jul 8, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@ROCKTAKEY, thank you for putting together this pull request and helping us once again with the documentation, this time by catching this issue with one of our examples. We appreciate it 🙏 !

I've checked and all is good on my end.

Will merge when the checklist clears.

Hope you have a great day.

Stay safe

Copy link

nx-cloud bot commented Jul 8, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 17ce575. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes merged commit 41053bf into storybookjs:next Jul 8, 2024
10 checks passed
@github-actions github-actions bot mentioned this pull request Jul 8, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants