docs: Improve readability of condition prop description for dependency functions#271
Open
docs: Improve readability of condition prop description for dependency functions#271
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation readability for the condition prop in the useConditionalEffect hook by adding HTML line breaks (<br />) to separate behavioral descriptions in both English and Korean documentation files.
- Adds line breaks between bullet points in the condition prop description for better visual separation
- Maintains identical content while improving formatting for documentation readers
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/hooks/useConditionalEffect/useConditionalEffect.md | Adds <br /> tags to separate bullet points in the condition prop description |
| src/hooks/useConditionalEffect/ko/useConditionalEffect.md | Adds <br /> tags to separate bullet points in the Korean condition prop description |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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 refines the documentation for the
conditionprop by formatting the description for better readability in both Korean and English. Now, each behavioral case (about initial render and return values) is clearly separated using line breaks for easier understanding.Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?