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.

Sign up for GitHub

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

Jump to bottom

Document declaration-property-value-no-unknown syntax reference #8193

Merged
merged 2 commits into from
Dec 14, 2024
Merged

Document declaration-property-value-no-unknown syntax reference #8193

merged 2 commits into from
Dec 14, 2024
+2 −0

Conversation

ryo-manba
Copy link
Member

Which issue, if any, is this issue related to?

Closes #8153

Is there anything in the PR that needs further explanation?

No, it's self-explanatory.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Dec 14, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: b9d2149

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

jeddy3
jeddy3 reviewed Dec 14, 2024
View reviewed changes
Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

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

@ryo-manba Thanks for getting the ball rolling with these PRs.

I've made a suggestion for the wording and position.

lib/rules/declaration-property-value-no-unknown/README.md Outdated
@@ -24,6 +24,8 @@ It sometimes overlaps with:

If duplicate problems are flagged, you can turn off the corresponding rule.

For more details on CSS value definition syntax, refer to the [CSSTree Syntax Reference](https://csstree.github.io/docs/syntax/).
Copy link
Member

Choose a reason for hiding this comment

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

We tend to favour the active voice in our docs. How about we put the following after the 1st line and before the "This rule is only appropriate for CSS..." one:

You can filter the CSSTree Syntax Reference to find out what value syntax is known for a property.

That'll keep the related bits of the extended description together.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good suggestion! I've applied it.

@ryo-manba ryo-manba requested a review from jeddy3 December 14, 2024 15:36
jeddy3
jeddy3 approved these changes Dec 14, 2024
View reviewed changes
Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you.

@jeddy3 jeddy3 merged commit dc84af3 into stylelint:main Dec 14, 2024
17 checks passed
@ryo-manba ryo-manba deleted the docs/declaration-property-value-no-unknown-syntax-reference branch December 14, 2024 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeddy3 jeddy3 jeddy3 approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document declaration-property-value-no-unknown syntax reference
2 participants
@ryo-manba @jeddy3