Skip to content

docs: update code example and some contents#195

Merged
seungrodotlee merged 7 commits into
toss:mainfrom
jsparkdev:intro
Apr 24, 2025
Merged

docs: update code example and some contents#195
seungrodotlee merged 7 commits into
toss:mainfrom
jsparkdev:intro

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

Overview

  • add missing inline code
  • rename state update function
  • update unnatural Korean translation

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 06:11
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 introductory documentation in both English and Korean to improve clarity and consistency. Key changes include:

  • Adding missing inline code formatting around "react-simplikit".
  • Renaming the state update function from setOpen to setIsOpen.
  • Updating the Korean translation for a more natural tone.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/docs/ko/intro.md Updated code sample naming and refined translation.
src/docs/en/intro.md Updated inline code formatting and naming convention.

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.

How about keep setOpen?

@jsparkdev
Copy link
Copy Markdown
Contributor Author

@seungrodotlee

Thanks for good review.

I've fixed it to be consistent with the state names used on other page.

If this was the intent, I'll leave setOpen as is.

@seungrodotlee
Copy link
Copy Markdown
Contributor

seungrodotlee commented Apr 24, 2025

Oh, I missed that — thanks for pointing it out.
It might be a good idea to review the naming style in the example code.
Personally, I find the set* format more intuitive than setIs*.

Would you mind unifying the naming style in this PR accordingly?

@jsparkdev jsparkdev changed the title docs(intro): update English and Korean documents docs: update code example and some contents Apr 24, 2025
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 5ca32de into toss:main Apr 24, 2025
5 checks passed
@jsparkdev jsparkdev deleted the intro branch April 24, 2025 15:11
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