Unit control Utils: update JS Docs and add basic test coverage #32774
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…his commit updates the param and return types to reflect current usage and adds some basic test coverage.
ramonjd
requested review from
ajitbohra,
chrisvanpatten,
oandregal and
spacedmonkey
as code owners
ramonjd
force-pushed
the
add/unit-contol-utils-tests
branch
from
27bf26d to
740f9fa
Compare
ramonjd
added
[Type] Code Quality
|
Size Change: 0 B Total Size: 1.04 MB ℹ️ View Unchanged
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The JS Docs defining the argument property types for
useCustomUnits()did not match examples of usage, where some properties wereundefined.Examples:
font-size-picker/index.js
This was causing Type warnings.
This commit updates the param and return types to reflect current usage and adds some basic test coverage.
The types in the JS Doc describing objects are still not super specific, but this PR aims only to remove the warning for now.
How has this been tested?
npm run test-unit packages/components/src/unit-control/test/utils.jsScreenshots
Types of changes
No code changes. We're only updating documentation and adding unit tests.