Skip to content

Commit

Permalink
fix(docs): corrects common typos in project documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
plan-do-break-fix committed Apr 25, 2021
1 parent 1ae828b commit ffab280
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/APIRef.Artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ interface TestSummary {
*/
title: string;
/**
* Full name of the current test, usually preceeded by a suite name, e.g.:
* Full name of the current test, usually preceded by a suite name, e.g.:
* describe('that screen', () =>
* it('should have a menu', () =>
* The expected string would be: "that screen should have a menu".
Expand Down
2 changes: 1 addition & 1 deletion docs/Guide.DebuggingInAndroidStudio.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ If you are using Jest as a test runner, you might want to increase the test time

Also, if there is something you want to do step by step in JS code while debugging native, append
`--inspect-brk` flag. To learn more about debugging with `--inspect-brk`, refer to
[Debugging — Getting Started](https://nodejs.org/en/docs/guides/debugging-getting-started/) on the offical Node.js website.
[Debugging — Getting Started](https://nodejs.org/en/docs/guides/debugging-getting-started/) on the official Node.js website.

Afterwards, you should see your test suite starting as usual until it reaches the app launch, where
Detox stops instead and prompts you to launch the app from the IDE:
Expand Down
2 changes: 1 addition & 1 deletion docs/Introduction.Android.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ A special thanks to [GEllickson-Hover](https://github.com/GEllickson-Hover) for

### 8. Test Butler Support (Optional)

If, when [setting up your work environment](Introduction.AndroidDevEnv.md), you've selected Google emulators with an AOSP image as the test target - as recommended, **we strongly encourage** you would also integrate [Test Butler](https://github.com/linkedin/test-butler): in the very least - in order to supress crash & ANR's dialogs. They are a soft spot in UI testing on Android, all around, as - when displayed, they make the UI entirely inaccessible (and thus cause tests to fail in bulks).
If, when [setting up your work environment](Introduction.AndroidDevEnv.md), you've selected Google emulators with an AOSP image as the test target - as recommended, **we strongly encourage** you would also integrate [Test Butler](https://github.com/linkedin/test-butler): in the very least - in order to suppress crash & ANR's dialogs. They are a soft spot in UI testing on Android, all around, as - when displayed, they make the UI entirely inaccessible (and thus cause tests to fail in bulks).

Setting Test Butler up for working with Detox is a bit different than explained in their guides. The process, as a whole, is twofold:

Expand Down
2 changes: 1 addition & 1 deletion docs/Troubleshooting.Synchronization.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ You can also modify your app, for the sake of tests only, by using mocking. Read

#### setTimeout and setInterval

By default, Detox is designed to ignore `setInterval` and will only wait for `setTimeout` of up to 1.5 seconds. If you have an endless polling loop with short intervals implemented with `setTimeout`, switch the implementation to `setInterval`. If possible, avoid agressive polling in your app altogether, the poor single JavaScript thread we have doesn't like it.
By default, Detox is designed to ignore `setInterval` and will only wait for `setTimeout` of up to 1.5 seconds. If you have an endless polling loop with short intervals implemented with `setTimeout`, switch the implementation to `setInterval`. If possible, avoid aggressive polling in your app altogether, the poor single JavaScript thread we have doesn't like it.

#### Endless looping animations

Expand Down
2 changes: 1 addition & 1 deletion examples/demo-native-ios/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

* make sure you have Xcode installed (tested with v8.1-8.2)
* iPhone 7 Plus simulator is installed
* make sure you have node installed (`brew install node`, node 8.3.0 and up is prefered, for native async-await support)
* make sure you have node installed (`brew install node`, node 8.3.0 and up is preferred, for native async-await support)

### Step 1: Npm install
* Make sure you're in folder `examples/demo-native-ios`
Expand Down

0 comments on commit ffab280

Please sign in to comment.