docs(eng): standardize React hook descriptions for consistency#207
Merged
seungrodotlee merged 7 commits intoMay 7, 2025
Conversation
Contributor
seungrodotlee
left a comment
There was a problem hiding this comment.
Thanks!
Can you update their jsdocs too?
Because we have to sync jsdoc and docs.
…m in documentation
…th hook description in the md documentation
… description in the md documentation
Contributor
Author
Thank you for the feedback! I’ve updated the JSDocs to match the latest changes as well, so they stay in sync with the docs. Let me know if there’s anything else you’d like me to adjust. |
seungrodotlee
approved these changes
May 7, 2025
Contributor
seungrodotlee
left a comment
There was a problem hiding this comment.
Thanks! 👍
Sorry for late approve
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #207 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 33 33
Lines 839 839
Branches 254 254
=========================================
Hits 839 839 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Overview
This PR standardizes the English documentation format for React hooks throughout the codebase. I've updated all English hook descriptions to follow a consistent pattern: "
[hookName]is a React hook that..." followed by a clear explanation of its functionality and benefits.The standardized format improves readability, makes the documentation more professional, and helps users quickly understand each hook's purpose. All technical details remain accurate while benefiting from a more consistent presentation style.
Checklist
yarn test:coverageto make sure there is no uncovered line?