Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit 55fe53a

Browse files
gkalpakcnishina
authored andcommitted
docs(exampleTypescript): improve comments and readme (#3406)
1 parent ee70e6e commit 55fe53a

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

Diff for: exampleTypescript/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The ambient typings are downloaded from DefinitelyTyped in the `postinstall` ste
4848

4949
## Protractor typings
5050

51-
To use Protractor types, you'll need to import `protractor/globals`. After this is imported, you should have auto completition hints when typing.
51+
To use Protractor types, you'll need to import `protractor/globals`. After this is imported, you should have autocompletion hints when typing.
5252

5353
```
5454
import {browser, element, by, By, $, $$, ExpectedConditions} from 'protractor/globals';
@@ -66,12 +66,12 @@ export let config: Config = {
6666

6767
## Ambient typings
6868

69-
Protractor also uses ambient types including jasmine and node. These are brought in via the `typings.json` file. The ambient typings files are imported from the `typings/index.d.ts` generated file and are included in the project via the tsconfig.json configuration file.
69+
Protractor also uses ambient types including jasmine and node. These are brought in via the `typings.json` file. The ambient typings files are imported from the `typings/index.d.ts` generated file and are included in the project via the `tsconfig.json` configuration file.
7070

7171

7272
## Compiling your code
7373

74-
To convert your typescript to javascript (transpiling), you'll use the Typescript comipler (tsc). If you install typescript globally, the command is `tsc`. If it is not installed globally, the typescript compiler can be executed with `npm run tsc`.
74+
To convert your typescript to javascript (transpiling), you'll use the Typescript compiler (tsc). If you install typescript globally, the command is `tsc`. If it is not installed globally, the typescript compiler can be executed with `npm run tsc`.
7575

7676
## Running Protractor
7777

Diff for: exampleTypescript/conf.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
// information.
44
//
55
// Why you might want to create your config with typescript:
6-
// edtiors like Microsoft Visual Studio Code will have autocomplete and
6+
// Editors like Microsoft Visual Studio Code will have autocomplete and
77
// description hints.
88
//
9-
// To run this example, run 'npm run tsc' to transpile the typescript to
10-
// javascript. run with 'protractor conf.js'
9+
// To run this example, first transpile it to javascript with `npm run tsc`,
10+
// then run `protractor conf.js`.
1111
import {Config} from 'protractor';
1212

13-
export let config: Config = {
13+
export let config: Config = {
1414
framework: 'jasmine',
1515
capabilities: {
1616
browserName: 'chrome'

Diff for: exampleTypescript/confPageObjects.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
// information.
44
//
55
// Why you might want to create your config with typescript:
6-
// edtiors like Microsoft Visual Studio Code will have autocomplete and
6+
// Editors like Microsoft Visual Studio Code will have autocomplete and
77
// description hints.
88
//
9-
// To run this example, run 'npm run tsc' to transpile the typescript to
10-
// javascript. run with 'protractor conf_withPageObjects.js'
9+
// To run this example, first transpile it to javascript with `npm run tsc`,
10+
// then run `protractor confPageObjects.js`.
1111
import {Config} from 'protractor';
1212

13-
export let config: Config = {
13+
export let config: Config = {
1414
framework: 'jasmine',
1515
capabilities: {
1616
browserName: 'chrome'

0 commit comments

Comments
 (0)