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: Make webpackFinal consistent across docs #25038

Merged
merged 4 commits into from
Dec 5, 2023

Conversation

kylemeenehan
Copy link
Contributor

What I did

Makes the implementation of webpackFinal consistent across documentation.

In the documentation there is both,

webpackFinal: async (...

and,

async webpackFinal(...

While these are both valid, I feel the documentation is easier to read if implementation is consistent?

I've aligned these cases to the style that is used elsewhere.

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

None that I'm aware of?

Manual testing

I'm not sure how to run the docs locally? Apologies if I've missed that somewhere. Testing should be as follows:

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>

@jonniebigodes jonniebigodes self-assigned this Nov 29, 2023
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 29, 2023
@jonniebigodes jonniebigodes changed the title make webpackFinal consistent across docs Docs: Make webpackFinal consistent across docs Dec 5, 2023
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.

@kylemeenehan, thanks for putting together this pull request and helping us improve the documentation by fixing these two snippets and standardizing the snippets for consistency. Appreciate it 🙏 ! I've checked, and I'm with you on this.

I'll gladly merge this once the checklist clears.

Hope you have a fantastic day.

Stay safe

@jonniebigodes jonniebigodes merged commit 43d6dd3 into storybookjs:next Dec 5, 2023
11 checks passed
@kylemeenehan
Copy link
Contributor Author

@kylemeenehan, thanks for putting together this pull request and helping us improve the documentation by fixing these two snippets and standardizing the snippets for consistency. Appreciate it 🙏 ! I've checked, and I'm with you on this.

I'll gladly merge this once the checklist clears.

Hope you have a fantastic day.

Stay safe

No worries! Thanks for the great tool! Storybook makes my job a lot easier!

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