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

Fixup documentation briefly for sortShorthand #1718

Merged
merged 2 commits into from
Oct 11, 2024

Conversation

kylorhall-atlassian
Copy link
Collaborator

What is this change?

Updating documentation around the sortShorthand config as I was confused myself setting it up in a new repo.

PR checklist

  • Updated or added applicable tests – n/a
  • Updated the documentation in website/

Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: 7122c7d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Oct 10, 2024

Deploy Preview for compiled-css-in-js canceled.

Name Link
🔨 Latest commit 7122c7d
🔍 Latest deploy log https://app.netlify.com/sites/compiled-css-in-js/deploys/67088448ad4d5b0008ffa687

@@ -116,14 +116,3 @@ See [Shorthand properties](/shorthand) for more information.

- Type: `boolean`
- Default: `false`

#### sortShorthand
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is just a duplicate (the section above is the same)

```js
{
loader: '@compiled/webpack-loader',
options: { sortShorthand: true }
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Is this even right? It's a bit unclear to me…

Copy link
Collaborator

@dddlr dddlr Oct 10, 2024

Choose a reason for hiding this comment

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

docs changes look reasonable, let me double check in the repo

Copy link
Collaborator

Choose a reason for hiding this comment

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

oh this is incorrect, sortShorthand exists for CompiledExtractPlugin but not @compiled/webpack-loader

see current docs https://compiledcssinjs.com/docs/pkg-webpack-loader where sortShorthand is listed under the options for CompiledExtractPlugin but not listed under the options for @compiled/webpack-loader

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh, I got how this documentation works now 😅 I'll just keep the example so someone doesn't misunderstand it like I did.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Both fixed in f8d041e

Copy link
Collaborator

@dddlr dddlr left a comment

Choose a reason for hiding this comment

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

apart from #1718 (comment), lgtm

Copy link
Collaborator

@dddlr dddlr left a comment

Choose a reason for hiding this comment

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

👍

@kylorhall-atlassian kylorhall-atlassian force-pushed the kylorhall/sortshorthand-documentation branch from f8d041e to a3843bd Compare October 11, 2024 00:51
@kylorhall-atlassian kylorhall-atlassian force-pushed the kylorhall/sortshorthand-documentation branch from a3843bd to 7122c7d Compare October 11, 2024 01:49
@kylorhall-atlassian kylorhall-atlassian merged commit c66555b into master Oct 11, 2024
13 checks passed
@kylorhall-atlassian kylorhall-atlassian deleted the kylorhall/sortshorthand-documentation branch October 11, 2024 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants