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

size/compose/remToDp filter should be documented as isDimension #1413

Open
thomasleduc opened this issue Dec 13, 2024 · 0 comments · May be fixed by #1414
Open

size/compose/remToDp filter should be documented as isDimension #1413

thomasleduc opened this issue Dec 13, 2024 · 0 comments · May be fixed by #1414

Comments

@thomasleduc
Copy link

thomasleduc commented Dec 13, 2024

The documentation problem

There is a wrong documentation on the matcher type of the predefined transformer size/compose/remToDp.

Explanation

We can see here that size/compose/remToDp is filtered by isDimension while size/compose/remToSp is filtered by isFontSize.

Which is perfectly correct.

In the meantime, in documentation, we have Matches: token.type === 'isFontSize' for Dp.

Just reporting it, because I struggle with it. Unfortunately, I don't have time to do any PR. :/

What expected

Change the documentation from Matches: token.type === 'isFontSize' to Matches: token.type === 'dimension'.

Thanks a lot :)

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

Successfully merging a pull request may close this issue.

2 participants