docs(core, mobile): fix typos and incorrect descriptions#359
Open
docs(core, mobile): fix typos and incorrect descriptions#359
Conversation
- Fix misspelled type parameter `InstrinsicElements` → `IntrinsicElementsOf` - Fix `occured` → `occurred` in test descriptions and docs - Fix grammar `re-render occur` → `re-renders occur` in JSDoc - Fix duplicate period in subscribeKeyboardHeight doc - Fix Korean typos: `이예요` → `이에요`, `안전해요요` → `안전해요` - Fix incorrect return value descriptions in ko docs for isKeyboardVisible, isIOS, isAndroid
There was a problem hiding this comment.
Pull request overview
This PR fixes typos and corrects inaccurate documentation (including Korean docs) across core and mobile, and updates a misspelled type parameter name in ImpressionArea.
Changes:
- Corrects multiple typos/grammar issues in docs, JSDoc, and test descriptions (e.g., “occurred”, “re-renders occur”, duplicate punctuation).
- Fixes incorrect boolean return descriptions in Korean docs for
isKeyboardVisible,isIOS, andisAndroid. - Renames a misspelled type parameter (
InstrinsicElements→IntrinsicElementsOf) inImpressionArea.tsx.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/mobile/src/utils/subscribeKeyboardHeight/subscribeKeyboardHeight.md | Fixes duplicate period in return value description. |
| packages/mobile/src/utils/isKeyboardVisible/ko/isKeyboardVisible.md | Corrects Korean return description to match actual boolean semantics. |
| packages/mobile/src/utils/isIOS/ko/isIOS.md | Corrects Korean return description to match actual boolean semantics. |
| packages/mobile/src/utils/isAndroid/ko/isAndroid.md | Corrects Korean return description to match actual boolean semantics. |
| packages/mobile/src/utils/disableBodyScrollLock/ko/disableBodyScrollLock.md | Fixes Korean typo in introductory description. |
| packages/core/src/hooks/useStorageState/useStorageState.spec.ts | Fixes typo in test case description (“occurred”). |
| packages/core/src/hooks/usePrevious/usePrevious.ts | Fixes grammar in JSDoc (“re-renders occur”). |
| packages/core/src/hooks/usePrevious/ko/usePrevious.md | Fixes Korean typo in example comment. |
| packages/core/src/components/ImpressionArea/ImpressionArea.tsx | Fixes misspelled generic type parameter name. |
| docs/ko/core/contributing.md | Fixes typo in example test description (“occurred”). |
| docs/core/contributing.md | Fixes typo in example test description (“occurred”). |
- Fix double space in useBodyScrollLock JSDoc comment - Fix reversed true/false in isServer Korean doc description - Fix awkward phrasing in useStorageState Korean doc - Fix subject-verb agreement in docs/core/intro.md
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.
Summary
InstrinsicElements→IntrinsicElementsOfinImpressionArea.tsxoccured→occurredin test descriptions and contributing docs (3 occurrences)re-render occur→re-renders occurinusePreviousJSDocsubscribeKeyboardHeightdoc이예요→이에요,안전해요요→안전해요isKeyboardVisible,isIOS,isAndroid(were describing wrong boolean values)Test plan
yarn run test:typepasses