Skip to content

docs(eng): standardize React hook descriptions for consistency#207

Merged
seungrodotlee merged 7 commits into
toss:mainfrom
yjwhy:docs/hooks-eng-descriptions-update
May 7, 2025
Merged

docs(eng): standardize React hook descriptions for consistency#207
seungrodotlee merged 7 commits into
toss:mainfrom
yjwhy:docs/hooks-eng-descriptions-update

Conversation

@yjwhy
Copy link
Copy Markdown
Contributor

@yjwhy yjwhy commented Apr 21, 2025

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

  • 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?

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!

Can you update their jsdocs too?

Because we have to sync jsdoc and docs.

@yjwhy
Copy link
Copy Markdown
Contributor Author

yjwhy commented Apr 25, 2025

Thanks!

Can you update their jsdocs too?

Because we have to sync jsdoc and docs.

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.

@yjwhy yjwhy requested a review from seungrodotlee April 25, 2025 23:30
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! 👍
Sorry for late approve

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8aecbf4) to head (f290110).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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:
  • ❄️ 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.

@seungrodotlee seungrodotlee merged commit 4a347e4 into toss:main May 7, 2025
7 of 8 checks passed
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