Skip to content
This repository was archived by the owner on Aug 1, 2020. It is now read-only.

Commit d152059

Browse files
committed
finish v4 docs
1 parent 8bbf7e1 commit d152059

File tree

9 files changed

+12
-11
lines changed

9 files changed

+12
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1>(React) Native Testing Library Docs</h1>
2+
<h1>React Native Testing Library Docs</h1>
33

44
<a href="https://www.joypixels.com/emoji/1f433">
55
<img

docs/api-helpers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ sidebar_label: Helpers
66

77
## Custom Queries
88

9-
RNTL exposes some of the helper functions that are used to implement the default queries. You can
9+
A few helper functions are exposed that are used internally to implement the default queries. You can
1010
use the helpers to build custom queries. For example, the code below shows a way to query your
1111
TestInstance by a `style` prop. Note: test files would need to now import `test-utils.js` instead of
12-
importing directly from RNTL. Also note, please never actually implement this helper, it's just an
12+
importing directly from `@testing-library/react-native`. Also note, please never actually implement this helper, it's just an
1313
example of what's possible.
1414

1515
```javascript

docs/api-queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ of string matching:
319319

320320
### Normalization
321321

322-
Before running any matching logic against text, RNTL automatically normalizes that text. By default,
322+
Before running any matching logic against text, it is automatically normalized. By default,
323323
normalization consists of trimming whitespace from the start and end of text, and collapsing
324324
multiple adjacent whitespace characters into a single space.
325325

docs/cheat-sheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Cheat Sheet
55
---
66

77
There is a printable one-page cheat sheet available for you to download. It is intended to be a
8-
quick reference for RNTL, but is not a complete API glossary or guide. Keep a copy of it on your
8+
quick reference, but is not a complete API glossary or guide. Keep a copy of it on your
99
desk to quickly take a peek at the most commonly used functionality!
1010

1111
[Download the cheat sheet][cheatsheet]

docs/ecosystem-jest-native.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Jest Matchers
44
sidebar_label: Jest Matchers
55
---
66

7-
[`jest-native`](https://github.com/testing-library/jest-native) is a companion library for RNTL that
7+
[`jest-native`](https://github.com/testing-library/jest-native) is a companion library that
88
provides custom element matchers for Jest.
99

1010
```

docs/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Native.
1414

1515
## This solution
1616

17-
Native Testing Library (RNTL) is an implementation of the well-known Testing Library API that works
17+
React Native Testing Library (RNTL) is an implementation of the well-known Testing Library API that works
1818
for React Native. The primary goal is to mimic the testing library API as closely as possible while
1919
still accounting for the differences in the platforms. Accomplishing this is no small feat because
2020
of the differences between the two platforms. Although most framework implementations like React
@@ -23,7 +23,7 @@ this library needed to have its own base implementation as well as a user-facing
2323
uses the [react-test-renderer](https://reactjs.org/docs/test-renderer.html), whereas DOM Testing
2424
Library (DTL) uses JSDOM. The main philosophy here is that you should find elements on the "screen"
2525
the way users would. This approach is meant to give you confidence that your app is working as a
26-
cohesive unit. Just like DTL, RNTL's primary guiding principle is:
26+
cohesive unit. Testing Library's primary philosophy is:
2727

2828
> [The more your tests resemble the way your software is used, the more confidence they can give you.](guiding-principles.md)
2929

docs/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Setup
66

77
## Setting up your project
88

9-
The RNTL API should work out of the box for most tests. All of the snippets you'll find throughout
9+
The API should work out of the box for most tests. All of the snippets you'll find throughout
1010
the website work without any additional configuration assuming you use Jest and a moderately recent
1111
version of React Native.
1212

@@ -39,7 +39,7 @@ module.exports = {
3939

4040
It's often useful to define a custom render method that includes things like global context
4141
providers, data stores, etc. To make this available globally, one approach is to define a utility
42-
file that re-exports everything from RNTL. You can replace `@testing-library/react-native` with this
42+
file that re-exports everything from this library. You can replace `@testing-library/react-native` with this
4343
file in all your imports. See [below](#configuring-jest-with-test-utils) for a way to make your test
4444
util file accessible without using relative paths.
4545

website/versioned_docs/version-2.0.0/api-render.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ most useful for creating reusable custom render functions for common data provid
5050

5151
### `queries`
5252

53-
Queries to bind. Overrides the default set from RNTL unless merged.
53+
Queries to bind. Overrides the default queries unless merged.
5454

5555
```js
5656
// Example, a function to traverse table contents

website/versions.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[
2+
"4.0.0",
23
"3.0.0",
34
"2.0.0"
45
]

0 commit comments

Comments
 (0)