Skip to content

[docs] Fix grammatical errors#4056

Merged
m-bert merged 7 commits intomainfrom
@mbert/docs-grammar
Apr 7, 2026
Merged

[docs] Fix grammatical errors#4056
m-bert merged 7 commits intomainfrom
@mbert/docs-grammar

Conversation

@m-bert
Copy link
Copy Markdown
Contributor

@m-bert m-bert commented Apr 3, 2026

Description

This PR fixes most of grammatical errors in our docs.

Test plan

Read docs 🤓

@m-bert m-bert added the Documentation Documentation change/enhancement label Apr 3, 2026
@m-bert m-bert requested review from Copilot and j-piasecki and removed request for Copilot April 3, 2026 11:20
@j-piasecki j-piasecki requested a review from Copilot April 3, 2026 11:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@m-bert m-bert requested a review from Copilot April 3, 2026 11:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@m-bert
Copy link
Copy Markdown
Contributor Author

m-bert commented Apr 7, 2026

I'm merging this PR as at this point it seems to be pointless to fight with copilot. Most of the critical mistakes are fixed so it is already improvement.

@m-bert m-bert merged commit 8baabdf into main Apr 7, 2026
1 check passed
@m-bert m-bert deleted the @mbert/docs-grammar branch April 7, 2026 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation change/enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants