Merge pull request #202 from ndresx/fix-docs-typos

Fix typos in Docs and GitHub related files

Author: mpeyper

.github/PULL_REQUEST_TEMPLATE.md

@@ -33,7 +33,7 @@ merge of your pull request!
 
 <!--
 To check an item, place an "x" in the box like so: "- [x] Documentation"
-Remove any items that are relevant to your changes
+Remove items that are irrelevant to your changes.
 -->
 
 - [ ] Documentation updated

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for wanting to make contribution and wanting to improve this library for everyone!
+Thanks for wanting to make a contribution and wanting to improve this library for everyone!
 
 ## Project setup
 
@@ -29,12 +29,11 @@ Please make sure to run the tests before you commit your changes. You can do so
 
 ### Update Typings
 
-The TypeScript type definitions are in the
-[DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks)
+The TypeScript type definitions can be found in the [DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react-hooks).
 
 ## Help needed
 
-Please checkout the
-[the open issues](https://github.com/testing-library/react-hooks-testing-library/issues)
+Please check out the
+[the open issues](https://github.com/testing-library/react-hooks-testing-library/issues).
 
 Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!

docs/api-reference.md

@@ -25,7 +25,7 @@ function renderHook(
 Renders a test component that will call the provided `callback`, including any hooks it calls, every
 time it renders.
 
-The `renderHook` function accept the following arguments:
+The `renderHook` function accepts the following arguments:
 
 ### `callback`
 
@@ -55,7 +55,7 @@ providers from `React.createContext` for the hook to access with `useContext`.
 
 ## `renderHook` Result
 
-The `renderHook` method returns an object that has a following properties:
+The `renderHook` function returns an object that has the following properties:
 
 ### `result`
 
@@ -76,7 +76,7 @@ function waitForNextUpdate(): Promise<void>
 ```
 
 - `waitForNextUpdate` (`function`) - returns a `Promise` that resolves the next time the hook
-  renders, commonly when state is updated as the result of a asynchronous action
+  renders, commonly when state is updated as the result of an asynchronous action.
 
 ### `rerender`
 
@@ -85,8 +85,7 @@ function rerender(newProps?: any): void
 ```
 
 A function to rerender the test component, causing any hooks to be recalculated. If `newProps` are
-passed, the will replace the `initialProps` passed to the `callback` function for the rerender any
-subsequent renders.
+passed, they will replace the `callback` function's `initialProps` for subsequent rerenders.
 
 ### `unmount`
 

docs/introduction.md

@@ -53,7 +53,7 @@ the results.
 
 ### When not to use this library
 
-1. Your hook is defined along side a component and is only used there
+1. Your hook is defined alongside a component and is only used there
 2. Your hook is easy to test by just testing the components using it
 
 ## Installation
@@ -83,5 +83,5 @@ npm install --save-dev react-test-renderer@^16.9.0
 ## Testing Framework
 
 In order to run tests, you will probably want to be using a test framework. If you have not already
-got one, we recommend using [jest](https://jestjs.io/), but this library should work without issues
+got one, we recommend using [Jest](https://jestjs.io/), but this library should work without issues
 with any of the alternatives.

test/autoCleanup.test.js

@@ -2,7 +2,7 @@ import { useEffect } from 'react'
 import { renderHook } from 'src'
 
 // This verifies that by importing RHTL in an
-// environment which supports afterEach (like jest)
+// environment which supports afterEach (like Jest)
 // we'll get automatic cleanup between tests.
 describe('auto cleanup tests', () => {
   let cleanupCalled = false