Skip to content

docs: add Comments section to CSS-in-JavaScript Style Guide#3174

Open
prateekbisht23 wants to merge 1 commit intoairbnb:masterfrom
prateekbisht23:docs/add-comments-section
Open

docs: add Comments section to CSS-in-JavaScript Style Guide#3174
prateekbisht23 wants to merge 1 commit intoairbnb:masterfrom
prateekbisht23:docs/add-comments-section

Conversation

@prateekbisht23
Copy link

What’s Changed

  • Added a new Comments section to the CSS-in-JavaScript Style Guide
  • Documented guidance on:
    • Allowing inline comments
    • Moving comments above lines when clearer
    • Handling long inline comments ( >100 chars )
    • Examples with // bad and // good patterns
    • Recommendation to refactor if excessive comments are needed

Why

Inline comments weren’t explicitly covered in the style guide.
This addition clarifies acceptable patterns and improves consistency with existing formatting.


fixes: #1506

@prateekbisht23
Copy link
Author

@ljharb can you review the PR!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants