Skip to content

docs(SwitchCase): add 'boolean' type#199

Merged
seungrodotlee merged 3 commits into
toss:mainfrom
KimCookieYa:main
Apr 24, 2025
Merged

docs(SwitchCase): add 'boolean' type#199
seungrodotlee merged 3 commits into
toss:mainfrom
KimCookieYa:main

Conversation

@KimCookieYa
Copy link
Copy Markdown
Contributor

@KimCookieYa KimCookieYa commented Apr 19, 2025

Overview

SwitchCase 의 value에 boolean이 실제로 사용 가능한데 문서와 타입 정의에는 빠져있어서 추가했습니다.

Checklist

  • Did you write the test code?
  • Have you run yarn test:coverage to make sure there is no uncovered line?
  • Did you write the JSDoc?

Copilot AI review requested due to automatic review settings April 19, 2025 11:00
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 19, 2025

@KimCookieYa is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@seungrodotlee seungrodotlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you edit JSDoc in SwitchCase too?
Because we have to sync docs and jsdoc.

@KimCookieYa
Copy link
Copy Markdown
Contributor Author

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!

Copy link
Copy Markdown
Contributor

@seungrodotlee seungrodotlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

@seungrodotlee seungrodotlee merged commit f942955 into toss:main Apr 24, 2025
8 of 9 checks passed
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (027711b) to head (dfd1156).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

4 participants