Skip to content

Commit cb20aeb

Browse files
author
Dan Humphrey
committed
Update typos and document clarifications
1 parent b0d0e41 commit cb20aeb

17 files changed

+59
-58
lines changed

docs/api/plugins/introduction.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The API is structured per domain of power (e.g. playback, record etc...).
1414

1515
### Versioning
1616

17-
`uri`s in the api start at `/`, and are versioned, the current living version is 1, calling a `uri` with no version means the latest one.
17+
`uri`s in the API start at `/`, and are versioned, the current living version is 1, calling a `uri` with no version means the latest one.
1818

1919
- `/register` - latest version of the register function.
2020
- `/v1/register` - register `v1`
@@ -32,23 +32,23 @@ Each one determines different functionality on the resource.
3232

3333
### Errors
3434

35-
When sending a request Selenium IDE will either not respond (if the window is closed), in which case the Promise will reject.
35+
If the window is closed when a request is sent, Selenium IDE will not respond and the Promise will reject.
3636

37-
Or if Selenium IDE is open it can either succeed which will resolve the Promise, or pass a "userland" error back to you, since errors can't be serialized.
37+
Alternatively, if Selenium IDE is open it can either succeed which will resolve the Promise, or pass a "userland" error back to you, since errors can't be serialized.
3838

39-
#### Connection Error
39+
#### Connection error
4040

41-
Connection error will happen when the IDE window is closed, therefore the promise will reject.
41+
A Connection error will occur when the IDE window is closed, therefore the promise will reject.
4242

4343
```js
4444
browser.runtime.sendMessage(SIDE_ID, payload).catch((error) => {
4545
console.error(error); // connection error
4646
});
4747
```
4848

49-
#### Request Error
49+
#### Request error
5050

51-
Request error will happen when a request is invalid, for example request a resource that doesn't exist, like [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), such requests **resolve** the promise with errors attached on them.
51+
A Request error will occur when a request is invalid, for example a request for a resource which doesn't exist, like [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). Such requests **resolve** the promise with errors attached on them.
5252

5353
```js
5454
browser.runtime.sendMessage(SIDE_ID, payload).then((response) => {
@@ -60,7 +60,7 @@ browser.runtime.sendMessage(SIDE_ID, payload).then((response) => {
6060

6161
#### Successful Request
6262

63-
A successful request is one where `error` is not defined on the response object, each endpoint has its own response, most `post` will respond with `true` if succeeded.
63+
A successful request is one where `error` is not defined on the response object. Each endpoint has its own response and most `post` requests will respond with `true` if successful.
6464

6565
```js
6666
browser.runtime.sendMessage(SIDE_ID, payload).then((response) => {

docs/api/plugins/playback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Playback
66

77
The Playback API is for the playback capabilities of Selenium IDE.
88

9-
It is prefix with `/playback`.
9+
It is prefixed with `/playback`.
1010

1111
### `GET /playback/location`
1212

docs/api/plugins/popup.md

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

7-
The Popup API deals with popups that the user can see.
7+
The Popup API deals with popups which the user can see.
88

99
This API is prefix with `/popup`.
1010

docs/api/plugins/record.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ title: Plugins Record API
44
sidebar_label: Record
55
---
66

7-
Record API concerns with the recording capabilities of Selenium IDE.
7+
The Record API is concerned with the recording capabilities of Selenium IDE.
88

99
This API is prefix with `/record`.
1010

1111
### `GET /record/tab`
1212

13-
Gets the `tabId` that the recorder is currently attached to (can be used even if not recording atm).
13+
Gets the `tabId` that the recorder is currently attached to (can be used even if not currently recording).
1414

1515
```js
1616
{

docs/api/plugins/system.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ title: Plugins System API
44
sidebar_label: System
55
---
66

7-
The System API is the most basic API Selenium IDE provides. It is not prefixed and can be called with `/`.
7+
The System API is the most basic API which Selenium IDE provides. It is not prefixed and can be called with `/`.
88

99
### `GET /health`
1010

1111
Used for plugin health checks, see [Plugin Health Checks](../../plugins/health-checks).
1212

1313
### `POST /register`
1414

15-
Used to register your plugin with Selenium IDE, this way the IDE knows of your existence, see [registering the plugin](../../plugins/plugins-getting-started#registering-the-plugin).
15+
Used to register your plugin with Selenium IDE, this way the IDE knows of your plugin's existence, see [registering the plugin](../../plugins/plugins-getting-started#registering-the-plugin).
1616

1717
### `POST /log`
1818

19-
Used for `system` logs, meaning when that the user can filter by system logs group.
19+
Used for `system` logs, meaning when the user can filter by system logs group.
2020
Logs that explain plugin usage, or status should be logged here.
2121

2222
```js

docs/introduction/command-line-runner.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Once everything's installed, running your tests is a simple matter of calling `s
3737

3838
_NOTE: If you have multiple `.side` files you can use a wildcard (e.g., `/path/to/*.side`)._
3939

40-
When you run this command it will launch your tests in parallel, in multiple browser windows, spread across `n` processes (where `n` is the number of available cores on your machine).
40+
When you run this command it will launch your tests in parallel, in multiple browser windows, spread across `n` processes (where `n` is the number of available CPU cores on your machine).
4141

4242
The number of processes is configurable (amongst other things) at run time through various arguments you can provide.
4343

44-
__NOTE: Parallel execution happens automically at the suite level. If you want the tests within a suite to be executed in parallel there is a setting you'll need to change. See [Test Parallelization In A Suite](command-line-runner.md#test-parallelization-in-a-suite) for details.__
44+
__NOTE: Parallel execution happens atomically at the suite level. If you want the tests within a suite to be executed in parallel, there is a setting you'll need to change. See [Test Parallelization In A Suite](command-line-runner.md#test-parallelization-in-a-suite) for details.__
4545

4646
## Run-time configuration
4747

@@ -75,17 +75,17 @@ When running on a Grid you will likely want to control how many parallel session
7575
selenium-side-runner -w 10 --server http://localhost:4444/wd/hub
7676
```
7777

78-
The runner will automatically set the number of workers to the amount of cores available on your computer. In most cases this is the best option.
78+
The runner will automatically set the number of workers to the same number of CPU cores available on your computer. In most cases this is the best option.
7979

8080
### Chrome specific capabilities
8181

82-
If you had Chrome installed in a non-standard location on your machine you could specify it so ChromeDriver knows where to look.
82+
If you have Chrome installed in a non-standard location on your machine you can specify the path so ChromeDriver knows where to look.
8383

8484
```sh
8585
selenium-side-runner -c "chromeOptions.binary='/path/to/non-standard/Chrome/install'"
8686
```
8787

88-
With Chrome specific capabilities you could also run the tests headlessly.
88+
With Chrome specific capabilities you can also run the tests headlessly.
8989

9090
```sh
9191
selenium-side-runner -c "chromeOptions.args=[disable-infobars, headless]"
@@ -113,7 +113,7 @@ selenium-side-runner --filter smoke
113113

114114
### Specify a default configuration
115115

116-
Rather than remembering all of the command-line arguments you need (which can become unwieldy) there's the ability to store your run-time parameters in a configuration file.
116+
Rather than remembering all of the command-line arguments you need (which can become unwieldy), you have the ability to store your run-time parameters in a configuration file.
117117

118118
There are two kinds of configuration files that you can use.
119119

@@ -142,7 +142,7 @@ __NOTE: When using the `--config-file` flag, the `.side.yml` will be ignored.__
142142

143143
## Selenium IDE Configuration
144144

145-
### Test Parallelization In A Suite
145+
### Test parallelization in a suite
146146

147147
Out of the box, the runner executes suites in parallel, but tests within a suite are executed sequentially.
148148

@@ -156,7 +156,7 @@ To run tests in a given suite in parallel, you'll need to update the settings fo
156156

157157
To configure more than one suite to run this way, repeat steps 1-4 in each suite. Be sure to save the project file once you're done.
158158

159-
## Advanced Options
159+
## Advanced options
160160

161161
### Additional params
162162

@@ -174,7 +174,7 @@ selenium-side-runner --params "a='example-value'"
174174

175175
#### Nested parameters
176176

177-
Parameters can also be nested using a dot-notation.
177+
Parameters can also be nested using dot-notation.
178178

179179
```sh
180180
selenium-side-runner --params "a.b='another example-value'"
@@ -202,7 +202,7 @@ You can pass proxy capabilities to the browser using the following options in th
202202

203203
#### Direct proxy
204204

205-
This options configures WebDriver to bypass all browser proxies.
205+
This option configures WebDriver to bypass all browser proxies.
206206

207207
##### From the command-line:
208208

@@ -294,4 +294,4 @@ proxyType: system
294294

295295
### Code export
296296

297-
If you're trying to learn how translate recorded tests into WebDriver code, or if you want to integrate recorded tests into an existing custom test framework, then what you need is code export which is on the project roadmap and will be available soon.
297+
If you're trying to learn how to translate recorded tests into WebDriver code, or if you want to integrate recorded tests into an existing custom test framework, then what you need is code export which is on the project roadmap and will be available soon.

docs/introduction/control-flow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ sidebar_label: Control Flow
66

77
Selenium IDE comes with commands that enable you to add conditional logic and looping to your tests.
88

9-
This enables you to execute commands (or a set of commands) only when certain conditions in your application are met. Or execute command(s) repeatedly based on pre-defined criteria.
9+
This enables you to execute commands (or a set of commands) only when certain conditions in your application are met, or execute command(s) repeatedly based on pre-defined criteria.
1010

1111
## JavaScript Expressions
1212

1313
Conditions in your application are checked by using JavaScript expressions.
1414

15-
You can use the `execute script` or `execute async script` commands to run a snippet of JavaScript at any point during your test and store the result in a variable. These variable can be used in a control flow command.
15+
You can use the `execute script` or `execute async script` commands to run a snippet of JavaScript at any point during your test and store the result in a variable. These variables can be used in a control flow command.
1616

1717
You can also use JavaScript expressions directly in the control flow commands.
1818

docs/introduction/faq.md

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

77
### How do I record hovers?
88

9-
Mouse over (a.k.a. hover) actions are difficult to automatically capture as part of a record cycle.
9+
Mouseover (a.k.a. hover) actions are difficult to automatically capture as part of a record cycle.
1010

1111
To add a hover to your test, there's a small bit of manual intervention required. And there are two different ways you can do it.
1212

@@ -44,7 +44,7 @@ There are certain circumstances where the built in wait strategies in the IDE ar
4444

4545
### How to install the IDE behind strict Proxy/Firewall?
4646

47-
In situations you may not have full public internet access (such as behind a "Corporate Proxy or Firewall"). In those environments you will need to obtain a copy of the built Selenium IDE ZIP file in order to record automated test scripts. This is available on GitHub's "Releases" section here:
47+
In some situations you may not have full public internet access (such as behind a "Corporate Proxy or Firewall"). In those environments you will need to obtain a copy of the built Selenium IDE ZIP file in order to record automated test scripts. This is available on GitHub's "Releases" section here:
4848

4949
https://github.com/SeleniumHQ/selenium-ide/releases
5050

docs/introduction/getting-started.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install Selenium IDE from either the <a href="https://chrome.google.com/webstore
1010

1111
## Launch the IDE
1212

13-
Once installed, launch it be clicking its icon from the menu bar in your browser.
13+
Once installed, launch it by clicking its icon from the menu bar in your browser.
1414

1515
### Troubleshooting
1616

@@ -31,16 +31,17 @@ The extension might be enabled but the icon is hidden. Try resizing the menu bar
3131

3232
In Chrome, you can do this by clicking to the right of the address bar, holding the click, and dragging it left or right.
3333

34-
In Firefox you need right-click, click `Customize`, make adjustments to the menu bar, and click `Done`.
34+
In Firefox you need to right-click, click `Customize`, make adjustments to the menu bar, and click `Done`.
3535

3636
## Welcome Screen
3737

3838
Upon launching the IDE you will be presented with a welcome dialog.
3939

40-
This will give you quick access the following options:
40+
This will give you quick access to the following options:
4141

42-
- Create a new project and start recording
42+
- Record a new test in a new project
4343
- Open an existing project
44+
- Create a new project
4445
- Close the IDE
4546

4647
If this is your first time using the IDE (or you are starting a new project), then select the first option.
@@ -49,7 +50,7 @@ If this is your first time using the IDE (or you are starting a new project), th
4950

5051
After creating a new project you will be prompted to name it and then asked to provide a base URL. The base URL is the URL of the application you are testing. It's something you set once and it gets used across all of the tests in this project. You can change it later if need-be.
5152

52-
After completing these settings a new browser window will open, load the base URL, and start recording.
53+
After completing these settings, a new browser window will open, load the base URL, and start recording.
5354

5455
Interact with the page and each of your actions will be recorded in the IDE. To stop recording, switch to the IDE window and click the recording icon.
5556

@@ -65,7 +66,7 @@ Once added you can either input commands manually, or click the record icon in t
6566

6667
Tests can be grouped together into suites.
6768

68-
On project creation a `Default Suite` gets created and your first test gets added to it automatically.
69+
On project creation, a `Default Suite` gets created and your first test gets added to it automatically.
6970

7071
To create and manage suites go to the `Test suites` panel. You can get there by clicking the drop-down at the top of the left side-bar menu (e.g., click on the word `Tests`) and selecting `Test suites`.
7172

@@ -75,7 +76,7 @@ To add a suite, click the `+` symbol at the top of the left side-bar menu to the
7576

7677
#### Add a test
7778

78-
To add a test to a suite hover over the suite name, do the following:
79+
To add a test to a suite hover over the suite name, then do the following:
7980

8081
1. Click on the icon that appears to the right of the `Test Suites` heading
8182
2. Click `Add tests`
@@ -96,7 +97,7 @@ To rename a suite hover over the suite name, click the icon that appears to the
9697

9798
To save everything you've just done in the IDE, click the save icon in the top-right corner of the IDE.
9899

99-
It will prompt you to for a location and name of where to save the project. The end result is a single file with an extension ending in `.side`.
100+
It will prompt you to for a location and name of where to save the project. The end result is a single file with a `.side` extension.
100101

101102
## Playback
102103

docs/plugins/adding-commands.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Adding Commands
66

77
To add a command to Selenium IDE firstly make sure to declare it in the [manifest](plugins-getting-started#the-manifest).
88

9-
After declaring the command Selenium IDE will expect you to respond to requests for it's execution and emission.
9+
After declaring the command, Selenium IDE will expect you to respond to requests for it's execution and emission.
1010

1111
## Executing a Command
1212

@@ -44,7 +44,7 @@ Command details the user has input in the table:
4444

4545
Playback options, detailing the execution environment:
4646

47-
- `runId` - optional, a unique identifier for the current test run, can be used to infer certain commands were ran in the same run.
47+
- `runId` - optional, a unique identifier for the current test run, can be used to infer certain commands were performed during the same run.
4848
- `testId` - a persistent unique identifier for a test, even though the test's content may change, the same identifier will always be sent.
4949
- `frameId` - `integer` or `0 || undefined` indicates under which frame the command should be executed, `0` or `undefined` indicates that the command should be executed at the `window` level.
5050
- `tabId` - the tab to execute the command in.
@@ -96,9 +96,9 @@ In order to run the test case using the [command-line runner](../introduction/co
9696

9797
Failing to provide it will result in the user getting an error when trying to save the test case.
9898

99-
Before implementing the command's code emitting, getting a general concept with how emitting works is a good idea ([link](emitting-code.md)).
99+
Before implementing the command's code emitting, it will be useful to understand the general concepts of how emitting works ([link](emitting-code.md)).
100100

101-
This article only concerns the command's test code, if your plugin needs to add setup and teardown code, see [Emitting Setup and Teardown Code](emitting-setup-teardown.md).
101+
This article is only concerned with the command's test code, if your plugin needs to add setup and teardown code, see [Emitting Setup and Teardown Code](emitting-setup-teardown.md).
102102

103103
Selenium IDE will send a request to emit the commands you've registered in the manifest.
104104

@@ -127,7 +127,7 @@ Command details the user has input in the table:
127127

128128
### Returning the Emitted Code
129129

130-
Once you've finished creating the JavaScript string to execute the command send it back to the IDE.
130+
Once you've finished creating the JavaScript string to execute the command, send it back to the IDE.
131131

132132
**Don't use the `return` keyword, if you need to wait on a Promise use `await`, `return` will cause the test to quit early.**
133133

0 commit comments

Comments
 (0)