Skip to content

Conversation

wo-o29
Copy link
Contributor

@wo-o29 wo-o29 commented Sep 13, 2025

Overview

This PR improves the documentation of the useThrottle hook by explicitly clarifying that the options.edges property's defaultValue represents the initial value.

While the defaultValue attribute already indicates the initial value, for users new to react-simplikit and its docs, it may not be immediately obvious visually.

Therefore, this description adds a clear note that the initial value is ['leading', 'trailing'] to enhance usability and maintain consistency with other documentation styles in the codebase.

Before After
스크린샷 2025-09-13 오후 4 52 08 스크린샷 2025-09-13 오후 4 51 55

This change follows the documentation style exemplified in the useLoading Docs.

Checklist

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

@Copilot Copilot AI review requested due to automatic review settings September 13, 2025 07:55
Copy link

@Copilot 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 improves the documentation clarity for the useThrottle hook by explicitly stating the initial value of the options.edges property in both English and Korean documentation files.

  • Adds clear indication that the initial value is ['leading', 'trailing'] to the description
  • Updates documentation in both English and Korean versions to maintain consistency

Reviewed Changes

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

File Description
src/hooks/useThrottle/useThrottle.md Enhanced English documentation with explicit initial value clarification
src/hooks/useThrottle/ko/useThrottle.md Enhanced Korean documentation with explicit initial value clarification

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

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.

1 participant