Conversation
m-bert
requested review from
Copilot and
j-piasecki
and removed request for
Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on improving the readability and professionalism of the Gesture Handler documentation by correcting grammar, punctuation, and wording across versioned and current docs.
Changes:
- Fixes common grammatical issues (agreement, articles, punctuation) across many docs pages.
- Improves consistency/clarity of technical descriptions (e.g., parameter descriptions and explanatory sentences).
- Removes/streamlines redundant wording in a few places.
Reviewed changes
Copilot reviewed 83 out of 83 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs-gesture-handler/versioned_docs/version-2.x/under-the-hood/state.md | Grammar fix (“its” vs “it’s”) in handler state description. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/under-the-hood/how-does-it-work.md | Grammar/wording fixes in under-the-hood overview. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/upgrading-to-2.md | Wording/punctuation improvements in upgrade guide. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/troubleshooting.md | Grammar fixes and punctuation polish in troubleshooting guide. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/testing.md | Grammar fixes in testing/Jest guidance. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/swipe-and-scroll.md | Wording improvements for clarity. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/quickstart/index.md | Grammar improvement in quickstart intro. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/guides/manual-gestures/index.md | Minor punctuation/wording fixes in step text. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/touch-events.md | Grammar fix in event field description. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/state-manager.md | Grammar improvement in state manager intro. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/pinch-gesture.md | Grammar/wording improvements in pinch gesture docs. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/pan-gesture.md | Grammar fixes in multi-touch and config sections. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/gesture-detector.md | Wording, punctuation, and typo fixes in detector docs. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/force-touch-gesture.md | Grammar fixes and clarity improvements. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/fling-gesture.md | Grammar improvements in parameter descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-event-data.md | Improves list item wording for pointer types. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-config.md | Grammar/spacing fixes and readability improvements. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/_shared/base-gesture-callbacks.md | Grammar fixes in callback descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/pinch-gh.md | Grammar/punctuation fixes in event data text. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/pan-gh.md | Grammar fixes and punctuation improvements. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/interactions.md | Minor punctuation improvement for clarity. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/force-gh.md | Grammar fixes and punctuation improvements. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/fling-gh.md | Grammar improvements in property descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/common-gh.md | Grammar fixes and improved phrasing in API docs. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/about-handlers.md | Grammar/wording improvements in conceptual overview. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/fundamentals/states-events.mdx | Grammar fixes (“its” vs “it’s”, “sent” vs “send”). |
| packages/docs-gesture-handler/versioned_docs/version-2.x/fundamentals/introduction.md | Grammar improvements in intro and community sections. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/fundamentals/gesture-composition.md | Grammar/punctuation fixes and clearer phrasing. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/components/touchables.md | Removes redundant sentence and improves wording. |
| packages/docs-gesture-handler/versioned_docs/version-2.x/components/reanimated_swipeable.md | Grammar fixes (“pannable”, punctuation, clarity). |
| packages/docs-gesture-handler/versioned_docs/version-2.x/components/buttons.mdx | Grammar fixes and clearer phrasing in component docs. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/troubleshooting.md | Grammar fixes in troubleshooting guidance. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/state.md | Grammar fix (“its” vs “it’s”) in state description. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/interactions.md | Minor punctuation improvement for readability. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/getting-started.md | Adds missing period and improves sentence correctness. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/example.md | Fixes verb agreement (“consists”). |
| packages/docs-gesture-handler/versioned_docs/version-1.x/credits.md | Adds missing ending period. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/contributing.md | Grammar fixes (pluralization, phrasing). |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/pinch-gh.md | Grammar fixes in intro and event attribute descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/pan-gh.md | Grammar fixes and clearer parameter descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/force-gh.md | Grammar fixes and punctuation improvements. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/fling-gh.md | Grammar improvements in property descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/common-gh.md | Grammar fixes in base handler documentation. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/components/touchables.md | Grammar fixes and removal of redundant sentence. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/components/swipeable.md | Grammar fixes and improved sentence structure. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/components/drawer-layout.mdx | Grammar fixes in prop descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/api/components/buttons.mdx | Grammar fixes in button docs and descriptions. |
| packages/docs-gesture-handler/versioned_docs/version-1.x/about-handlers.md | Grammar and punctuation improvements. |
| packages/docs-gesture-handler/docs/under-the-hood/how-does-it-work.md | Grammar/punctuation fixes in under-the-hood overview. |
| packages/docs-gesture-handler/docs/legacy-gestures/state-manager.md | Wording improvement in state manager intro. |
| packages/docs-gesture-handler/docs/legacy-gestures/pinch-gesture.md | Grammar improvements in pinch gesture docs. |
| packages/docs-gesture-handler/docs/legacy-gestures/pan-gesture.md | Grammar fixes in multi-touch and config sections. |
| packages/docs-gesture-handler/docs/legacy-gestures/native-gesture.md | Grammar fixes in prop descriptions. |
| packages/docs-gesture-handler/docs/legacy-gestures/gesture-detector.md | Grammar fixes across detector docs and example note. |
| packages/docs-gesture-handler/docs/legacy-gestures/gesture-composition.md | Grammar fixes and improved phrasing. |
| packages/docs-gesture-handler/docs/legacy-gestures/force-touch-gesture.md | Grammar fixes in min/max force docs. |
| packages/docs-gesture-handler/docs/legacy-gestures/fling-gesture.md | Grammar/punctuation fixes in gesture description and props. |
| packages/docs-gesture-handler/docs/legacy-gestures/_shared/base-gesture-config.md | Grammar fixes and clearer phrasing for shared config docs. |
| packages/docs-gesture-handler/docs/legacy-gestures/_shared/base-continuous-gesture-config.md | Adds punctuation for clarity. |
| packages/docs-gesture-handler/docs/guides/upgrading-to-3.mdx | Grammar fixes in upgrade guide wording. |
| packages/docs-gesture-handler/docs/guides/troubleshooting.mdx | Grammar and punctuation fixes across troubleshooting guide. |
| packages/docs-gesture-handler/docs/guides/testing.md | Grammar fixes in Jest setup instructions. |
| packages/docs-gesture-handler/docs/guides/swipe-and-scroll.md | Wording improvements for clarity. |
| packages/docs-gesture-handler/docs/gestures/use-tap-gesture.mdx | Grammar fix for sentence correctness. |
| packages/docs-gesture-handler/docs/gestures/use-pinch-gesture.mdx | Punctuation/wording fixes in event attribute descriptions. |
| packages/docs-gesture-handler/docs/gestures/use-pan-gesture.mdx | Grammar fixes in multi-touch and config docs. |
| packages/docs-gesture-handler/docs/gestures/use-native-gesture.mdx | Grammar fixes in prop descriptions. |
| packages/docs-gesture-handler/docs/gestures/use-manual-gesture.mdx | Grammar fixes and punctuation improvements. |
| packages/docs-gesture-handler/docs/gestures/use-hover-gesture.mdx | Adds missing period. |
| packages/docs-gesture-handler/docs/gestures/use-fling-gesture.mdx | Grammar fixes in description and prop docs. |
| packages/docs-gesture-handler/docs/gestures/_shared/base-gesture-config.mdx | Grammar fixes and improved phrasing in shared config docs. |
| packages/docs-gesture-handler/docs/gestures/_shared/base-continuous-gesture-config.md | Adds punctuation for readability. |
| packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx | Grammar fixes in lifecycle/state manager docs. |
| packages/docs-gesture-handler/docs/fundamentals/reanimated-interactions.mdx | Grammar/punctuation fixes and phrasing improvements. |
| packages/docs-gesture-handler/docs/fundamentals/introduction.md | Grammar improvements in intro, contributing, and community sections. |
| packages/docs-gesture-handler/docs/fundamentals/installation.mdx | Minor wording improvement for clarity. |
| packages/docs-gesture-handler/docs/fundamentals/gesture-detector.mdx | Grammar fixes in prop descriptions. |
| packages/docs-gesture-handler/docs/fundamentals/gesture-composition.mdx | Grammar fixes and corrected typo (“arguments”). |
| packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx | Grammar fixes and clearer phrasing in callback/event docs. |
| packages/docs-gesture-handler/docs/components/touchables.md | Grammar fixes and removal of redundant line. |
| packages/docs-gesture-handler/docs/components/reanimated-drawer-layout.mdx | Grammar fixes in prop/method descriptions. |
| packages/docs-gesture-handler/docs/components/reanimated_swipeable.mdx | Grammar fixes in prop description and hitSlop text. |
| packages/docs-gesture-handler/docs/components/buttons.mdx | Grammar and readability improvements across button docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/pinch-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/legacy-gestures/pinch-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/about-handlers.md
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 83 out of 83 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx
Outdated
Show resolved
Hide resolved
j-piasecki
approved these changes
Apr 3, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 83 out of 83 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/fling-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/gestures/use-fling-gesture.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/fling-gh.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/fling-gh.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/legacy-gestures/fling-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-2.x/gestures/pinch-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-2.x/gesture-handlers/pinch-gh.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/legacy-gestures/pinch-gesture.md
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/docs/gestures/use-pinch-gesture.mdx
Outdated
Show resolved
Hide resolved
packages/docs-gesture-handler/versioned_docs/version-1.x/api/gesture-handlers/pinch-gh.md
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 83 out of 83 changed files in this pull request and generated 9 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -12,32 +12,32 @@ import TabItem from '@theme/TabItem'; | |||
| Thanks for giving this library a try! We are sorry that you might have encountered issues though. Here is how you can seek help: | |||
|
|
|||
| 1. Search over the [issues on Github](https://github.com/software-mansion/react-native-gesture-handler/issues). There is a chance someone had this problem in the past and it has been resolved! | |||
There was a problem hiding this comment.
The brand name should be capitalized as “GitHub” (not “Github”) in this sentence.
| - Making sure the issue description is complete. Please include all the details about your environment (library version, RN version, device OS etc). | ||
| - It is the best to provide an example app that reproduces the issue you are having. Put it up on [gist](https://gist.github.com/), [snack](https://snack.expo.io) or create a repo on Github – it doesn't matter as long as we can easily pull it in, run and see the issue. | ||
| - Making sure the issue description is complete. Please include all the details about your environment (library version, RN version, device OS, etc.). | ||
| - It is best to provide an example app that reproduces the issue you are having. Put it up on [gist](https://gist.github.com/), [snack](https://snack.expo.io) or create a repo on Github – it doesn't matter as long as we can easily pull it in, run and see the issue. |
There was a problem hiding this comment.
The brand name should be capitalized as “GitHub” (not “Github”).
| import FunctionalComponents from './\_shared/gesture-detector-functional1.md'; | ||
|
|
||
| `GestureDetector` is the main component of the RNGH2. It is responsible for creating and updating native gesture handlers based on the config of provided gesture. The most significant difference between it and old gesture handlers is that the `GestureDetector` can recognize more than one gesture at the time thanks to gesture composition. Keep in mind that `GestureDetector` is not compatible with the [Animated API](https://reactnative.dev/docs/animated), nor with [Reanimated 1](https://docs.swmansion.com/react-native-reanimated/docs/1.x/). | ||
| `GestureDetector` is the main component of the RNGH2. It is responsible for creating and updating native gesture handlers based on the config of provided gesture. The most significant difference between it and old gesture handlers is that the `GestureDetector` can recognize more than one gesture at a time thanks to gesture composition. Keep in mind that `GestureDetector` is not compatible with the [Animated API](https://reactnative.dev/docs/animated), nor with [Reanimated 1](https://docs.swmansion.com/react-native-reanimated/docs/1.x/). |
There was a problem hiding this comment.
Grammar: “based on the config of provided gesture” reads incorrectly. Consider changing to “based on the config of the provided gesture”.
Comment on lines
+57
to
+61
| A number of fingers that is required to be placed before the handler can [activate](/docs/2.x/under-the-hood/state#active). Should be a higher or equal to 0 integer. | ||
|
|
||
| ### `maxPointers` | ||
|
|
||
| When the given number of fingers is placed on the screen and handler hasn't yet [activated](/docs/2.x/under-the-hood/state#active) it will fail recognizing the gesture. Should be a higher or equal to 0 integer. | ||
| When the given number of fingers is placed on the screen and the handler hasn't yet [activated](/docs/2.x/under-the-hood/state#active) it will fail recognizing the gesture. Should be a higher or equal to 0 integer. |
There was a problem hiding this comment.
Grammar: “Should be a higher or equal to 0 integer” is ungrammatical. Consider rephrasing to “Should be an integer greater than or equal to 0.” (applies to both minPointers and maxPointers descriptions here).
| ### `minPointers(value: number)` | ||
|
|
||
| A number of fingers that is required to be placed before gesture can [activate](/docs/2.x/fundamentals/states-events#active). Should be a higher or equal to 0 integer. | ||
| A number of fingers that is required to be placed before the gesture can [activate](/docs/2.x/fundamentals/states-events#active). Should be a higher or equal to 0 integer. |
There was a problem hiding this comment.
Grammar: “Should be a higher or equal to 0 integer” is ungrammatical. Consider “Should be an integer greater than or equal to 0.”
| ### `maxPointers(value: number)` | ||
|
|
||
| When the given number of fingers is placed on the screen and gesture hasn't yet [activated](/docs/2.x/fundamentals/states-events#active) it will fail recognizing the gesture. Should be a higher or equal to 0 integer. | ||
| When the given number of fingers is placed on the screen and the gesture hasn't yet [activated](/docs/2.x/fundamentals/states-events#active) it will fail recognizing the gesture. Should be a higher or equal to 0 integer. |
There was a problem hiding this comment.
Grammar: “Should be a higher or equal to 0 integer” is ungrammatical. Consider “Should be an integer greater than or equal to 0.”
Comment on lines
133
to
134
| ### `minPointers(value: number)` | ||
|
|
There was a problem hiding this comment.
In the minPointers section, the following sentence uses ungrammatical phrasing (“before gesture can…” / “Should be a higher or equal to 0 integer”). Consider rewording to “before the gesture can…” and “an integer greater than or equal to 0”.
| @@ -144,26 +144,26 @@ Duration in milliseconds of the `LongPress` gesture before `Pan` is allowed to [ | |||
|
|
|||
| ### `activeOffsetX(value: number | number[])` | |||
There was a problem hiding this comment.
The activateAfterLongPress description just above uses ungrammatical phrasing (“Should be a higher or equal to 0 integer”). Consider rephrasing to “Should be an integer greater than or equal to 0.”
Comment on lines
145
to
146
| ### `activateAfterLongPress(duration: number)` | ||
|
|
There was a problem hiding this comment.
The activateAfterLongPress description below still uses ungrammatical phrasing (“Should be a higher or equal to 0 integer”). Consider rephrasing to “Should be an integer greater than or equal to 0.”
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.
Description
This PR fixes most of grammatical errors in our docs.
Test plan
Read docs 🤓