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: remove unnecessary comment in README #18

Merged
merged 1 commit into from
Mar 4, 2022

Conversation

williamhzo
Copy link
Contributor

@williamhzo williamhzo commented Mar 3, 2022

Description

In the Examples section, the React (with CSS Modules) example mentions a disclaimer comment that isn't relevant for this example.

Additional context

The comment states // ⚠️ Disclaimer: Use of Tailwind CSS is optional although example is illustrating CSS modules usage.


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Follow the Style Guide.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).

@alii
Copy link

alii commented Mar 3, 2022

Why so? The codeblock below it uses tailwind classnames 🙂

@williamhzo
Copy link
Contributor Author

williamhzo commented Mar 4, 2022

Why so? The codeblock below it uses tailwind classnames

if i'm not mistaken this particular example (React with CSS Modules) is only using CSS modules, not Tailwind classes:

import {
  base,
  primary,
  secondary,
  small,
  medium,
  primaryMedium,
} from "./button.css";

@alii
Copy link

alii commented Mar 4, 2022

Ah my apologies, I was looking at the wrong part of the readme 😄
image

@williamhzo
Copy link
Contributor Author

williamhzo commented Mar 4, 2022

Ah my apologies, I was looking at the wrong part of the readme 😄

no worries, i wasn't able to link more precisely to the particular example :)

@joe-bell
Copy link
Owner

joe-bell commented Mar 4, 2022

Good spot, cheers @williamhzo!

@joe-bell joe-bell merged commit 040fc09 into joe-bell:main Mar 4, 2022
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