Skip to content

Commit 88d4276

Browse files
authored
Improve some documentation (#770)
1 parent 534ea33 commit 88d4276

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ practices.</p>
5454
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
5555

5656
- [The problem](#the-problem)
57-
- [This solution](#this-solution)
57+
- [The solution](#the-solution)
5858
- [Installation](#installation)
5959
- [Suppressing unnecessary warnings on React DOM 16.8](#suppressing-unnecessary-warnings-on-react-dom-168)
6060
- [Examples](#examples)
@@ -83,7 +83,7 @@ maintainable in the long run so refactors of your components (changes to
8383
implementation but not functionality) don't break your tests and slow you and
8484
your team down.
8585

86-
## This solution
86+
## The solution
8787

8888
The `React Testing Library` is a very lightweight solution for testing React
8989
components. It provides light utility functions on top of `react-dom` and
@@ -104,7 +104,7 @@ npm install --save-dev @testing-library/react
104104

105105
or
106106

107-
for installation via [yarn](https://classic.yarnpkg.com/en/)
107+
for installation via [yarn][yarn]
108108

109109
```
110110
yarn add --dev @testing-library/react
@@ -132,7 +132,7 @@ the following snippet to your test configuration
132132

133133
```js
134134
// this is just a little hack to silence a warning that we'll get until we
135-
// upgrade to 16.9: https://github.com/facebook/react/pull/14853
135+
// upgrade to 16.9. See also: https://github.com/facebook/react/pull/14853
136136
const originalError = console.error
137137
beforeAll(() => {
138138
console.error = (...args) => {
@@ -156,8 +156,8 @@ afterAll(() => {
156156
// hidden-message.js
157157
import React from 'react'
158158

159-
// NOTE: React Testing Library works with React Hooks _and_ classes just as well
160-
// and your tests will be the same however you write your components.
159+
// NOTE: React Testing Library works well with React Hooks and classes.
160+
// Your tests will be the same regardless of how you write your components.
161161
function HiddenMessage({children}) {
162162
const [showMessage, setShowMessage] = React.useState(false)
163163
return (
@@ -372,7 +372,7 @@ You can also find React Testing Library examples at
372372
If you are interested in testing a custom hook, check out [React Hooks Testing
373373
Library][react-hooks-testing-library].
374374
375-
> NOTE it is not recommended to test single-use custom hooks in isolation from
375+
> NOTE: it is not recommended to test single-use custom hooks in isolation from
376376
> the components where it's being used. It's better to test the component that's
377377
> using the hook rather than the hook itself. The `React Hooks Testing Library`
378378
> is intended to be used for reusable hooks/libraries.
@@ -383,7 +383,7 @@ Library][react-hooks-testing-library].
383383
> confidence they can give you.][guiding-principle]
384384
385385
We try to only expose methods and utilities that encourage you to write tests
386-
that closely resemble how your react components are used.
386+
that closely resemble how your React components are used.
387387
388388
Utilities are included in this project based on the following guiding
389389
principles:
@@ -397,8 +397,8 @@ principles:
397397
`react-dom`.
398398
3. Utility implementations and APIs should be simple and flexible.
399399
400-
At the end of the day, what we want is for this library to be pretty
401-
light-weight, simple, and understandable.
400+
Most importantly, we want React Testing Library to be pretty
401+
light-weight, simple, and easy to understand.
402402
403403
## Docs
404404
@@ -407,8 +407,8 @@ light-weight, simple, and understandable.
407407
408408
## Issues
409409
410-
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
411-
label._
410+
Looking to contribute? Look for the [Good First Issue][good-first-issue]
411+
label.
412412
413413
### 🐛 Bugs
414414
@@ -608,6 +608,7 @@ Contributions of any kind welcome!
608608
<!-- prettier-ignore-start -->
609609
610610
[npm]: https://www.npmjs.com/
611+
[yarn]: https://classic.yarnpkg.com
611612
[node]: https://nodejs.org
612613
[build-badge]: https://img.shields.io/travis/testing-library/react-testing-library.svg?style=flat-square
613614
[build]: https://travis-ci.org/testing-library/react-testing-library

0 commit comments

Comments
 (0)