docs: fix useEvent typos, tweak wording of main README opening summary#6690
Merged
kacperkapusciak merged 5 commits intosoftware-mansion:mainfrom Dec 4, 2024
Merged
Conversation
kacperkapusciak
approved these changes
Dec 4, 2024
Member
kacperkapusciak
left a comment
kacperkapusciak
left a comment
There was a problem hiding this comment.
Here, you dropped this -> 👑
Thank you!
tjzel
pushed a commit
that referenced
this pull request
Dec 13, 2024
…mmary (#6690) ## Summary This pull request makes 2 changes to the library's documentation: 1. In `useEvent` (versions 2 and 3), some typos, grammar details and instances of missing articles were corrected. 2. In the library's main `README`, it tweaks the wording of the document's opening summary to make it more clear and more fluent in its expression. I think `1` will be uncontroversial, but you might want to revert `2` if I've misunderstood what the author was trying to say. (Just noticed these things while reading the documentation this evening. Please take, edit and use these proposed changes as you see fit 🙏) --------- Co-authored-by: Kacper Kapuściak <39658211+kacperkapusciak@users.noreply.github.com>
tjzel
pushed a commit
that referenced
this pull request
Dec 13, 2024
…mmary (#6690) ## Summary This pull request makes 2 changes to the library's documentation: 1. In `useEvent` (versions 2 and 3), some typos, grammar details and instances of missing articles were corrected. 2. In the library's main `README`, it tweaks the wording of the document's opening summary to make it more clear and more fluent in its expression. I think `1` will be uncontroversial, but you might want to revert `2` if I've misunderstood what the author was trying to say. (Just noticed these things while reading the documentation this evening. Please take, edit and use these proposed changes as you see fit 🙏) --------- Co-authored-by: Kacper Kapuściak <39658211+kacperkapusciak@users.noreply.github.com>
tjzel
pushed a commit
that referenced
this pull request
Dec 13, 2024
…mmary (#6690) ## Summary This pull request makes 2 changes to the library's documentation: 1. In `useEvent` (versions 2 and 3), some typos, grammar details and instances of missing articles were corrected. 2. In the library's main `README`, it tweaks the wording of the document's opening summary to make it more clear and more fluent in its expression. I think `1` will be uncontroversial, but you might want to revert `2` if I've misunderstood what the author was trying to say. (Just noticed these things while reading the documentation this evening. Please take, edit and use these proposed changes as you see fit 🙏) --------- Co-authored-by: Kacper Kapuściak <39658211+kacperkapusciak@users.noreply.github.com>
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
2 participants
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
This pull request makes 2 changes to the library's documentation:
useEvent(versions 2 and 3), some typos, grammar details and instances of missing articles were corrected.README, it tweaks the wording of the document's opening summary to make it more clear and more fluent in its expression.I think
1will be uncontroversial, but you might want to revert2if I've misunderstood what the author was trying to say.(Just noticed these things while reading the documentation this evening. Please take, edit and use these proposed changes as you see fit 🙏)