docs(SwitchCase): add 'boolean' type#199
Conversation
|
@KimCookieYa is attempting to deploy a commit to the Toss Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the SwitchCase component's documentation and JSDoc comments to include the "boolean" type, clarifying that the component supports boolean values.
- Updated type definitions in both Korean and English documentation files.
- Updated JSDoc comments in the TypeScript file for consistency with the new type definitions.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/components/SwitchCase/ko/SwitchCase.md | Updated type definitions and interface documentation to include boolean. |
| src/components/SwitchCase/SwitchCase.tsx | Revised JSDoc comments to reflect the inclusion of boolean in the type unions. |
| src/components/SwitchCase/SwitchCase.md | Updated English documentation for type definitions to include boolean. |
seungrodotlee
left a comment
There was a problem hiding this comment.
Can you edit JSDoc in SwitchCase too?
Because we have to sync docs and jsdoc.
Got it. Upon reviewing, I noticed the JSDoc didn’t match the actual types. I’ve fixed it and pushed a new commit—please take a look. Thanks! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #199 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 33 33
Lines 839 839
Branches 254 254
=========================================
Hits 839 839 🚀 New features to boost your workflow:
|
Overview
SwitchCase 의 value에 boolean이 실제로 사용 가능한데 문서와 타입 정의에는 빠져있어서 추가했습니다.
Checklist
yarn test:coverageto make sure there is no uncovered line?