Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ericcarraway committed Jun 22, 2016
1 parent bff4d30 commit 2bba792
Show file tree
Hide file tree
Showing 15 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Original file line Diff line number Diff line change
@@ -1,6 +1,6 @@
## The problem ## The problem


Briefly describe the issue you are experiencing (or the feature you want to see added to WebdriverIO). Tell us what you were trying to do and what happened instead. Remember, this is _not_ a place to ask questions. For that, join the Gitter chat romm ([![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/webdriverio/webdriverio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge))! Briefly describe the issue you are experiencing (or the feature you want to see added to WebdriverIO). Tell us what you were trying to do and what happened instead. Remember, this is _not_ a place to ask questions. For that, join the Gitter chat room ([![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/webdriverio/webdriverio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge))!


## Environment ## Environment


Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ to know that you have a clean state.
grunt test:functional grunt test:functional
# wdio test runner changes # wdio test runner changes
# (e.g. any changes that reflect the behavor of the test runner e.g. in lib/launcher.js) # (e.g. any changes that reflect the behavior of the test runner e.g. in lib/launcher.js)
grunt test:wdio grunt test:wdio
# anything else unittestable # anything else unittestable
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/plugins/gulp-webdriver.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ gulp.task('test:e2e', function() {
gulp-webdriver makes the wdio testrunner easy accessible and allows you to run multiple config files gulp-webdriver makes the wdio testrunner easy accessible and allows you to run multiple config files
sequentially. If desired you can pass additional arguments to the wdio command to specify your test. sequentially. If desired you can pass additional arguments to the wdio command to specify your test.
You can find all available options [here](http://webdriver.io/guide/testrunner/gettingstarted.html) You can find all available options [here](http://webdriver.io/guide/testrunner/gettingstarted.html)
or by executin `$ wdio --help` (if you have WebdriverIO installed globally). or by executing `$ wdio --help` (if you have WebdriverIO installed globally).


```js ```js
gulp.task('test:e2e', function() { gulp.task('test:e2e', function() {
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/plugins/webdrivercss.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -151,10 +151,10 @@ available:
define a fixed height for your screenshot define a fixed height for your screenshot


* **x** `Number`<br> * **x** `Number`<br>
take screenshot at an exact xy postion (requires width/height option) take screenshot at an exact xy position (requires width/height option)


* **y** `Number`<br> * **y** `Number`<br>
take screenshot at an exact xy postion (requires width/height option) take screenshot at an exact xy position (requires width/height option)


* **exclude** `String[]|Object[]`<br> * **exclude** `String[]|Object[]`<br>
exclude frequently changing parts of your screenshot, you can either pass all kinds of different [WebdriverIO selector strategies](http://webdriver.io/guide/usage/selectors.html) exclude frequently changing parts of your screenshot, you can either pass all kinds of different [WebdriverIO selector strategies](http://webdriver.io/guide/usage/selectors.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/plugins/webdriverjs-angular.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ command.
You will not find any `elementByNgBinding`, `addMockModule`, You will not find any `elementByNgBinding`, `addMockModule`,
`hasElementByNgRepeaterRow` or any other specific, angularJS-related methods. `hasElementByNgRepeaterRow` or any other specific, angularJS-related methods.


We think your functionnal tests should be as framework-agnostic as possible. We think your functional tests should be as framework-agnostic as possible.


If you need `elementByNgBinding`, just use regular If you need `elementByNgBinding`, just use regular
[WebdriverIO](http://webdriver.io) [WebdriverIO](http://webdriver.io)
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/plugins/webdriverrtc.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Start with WebRTC analyzing.
#### options #### options
__instance__ (*String*):<br>instance name of a specific multibrowser instance you want to use for your analyzing<br><br> __instance__ (*String*):<br>instance name of a specific multibrowser instance you want to use for your analyzing<br><br>
__interval__ (*Number*):<br>defines the interval on which `getStats` will get called<br><br> __interval__ (*Number*):<br>defines the interval on which `getStats` will get called<br><br>
__selectorMethod__ (*Function*):<br>if you want to take stats of a specific RTCPeerConnection object you can use this function to return that object. Also necessary if your app creates an object immediatelly after the page got loaded.<br> __selectorMethod__ (*Function*):<br>if you want to take stats of a specific RTCPeerConnection object you can use this function to return that object. Also necessary if your app creates an object immediately after the page got loaded.<br>


Example: Example:


Expand Down Expand Up @@ -147,7 +147,7 @@ Returns all stats within given duration in different formats.
#### duration #### duration
You can specify a specific time frame in which you want to receive the stats. If you pass in a number You can specify a specific time frame in which you want to receive the stats. If you pass in a number
you will receive stats within the last x (your number) ms. You can also be more specific and pass in you will receive stats within the last x (your number) ms. You can also be more specific and pass in
an object with `from` and `to` attribues and desired timestamps as value respectively. If you pass in an object with `from` and `to` attributes and desired timestamps as value respectively. If you pass in
null, you will receive the last taken stat trace. null, you will receive the last taken stat trace.


Type: *Number|Object*<br> Type: *Number|Object*<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/testrunner/debugging.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The `no-preload` option defers loading source file until needed, this helps perf
## Dynamic configuration ## Dynamic configuration




Note that `wdio.conf` can contain javascript. Since you probably do not want to permanently change your timeout value to 1 day, it can be often helpful to change these settings from the commanedline using an environment variable. This can used to dynamically change the configuration: Note that `wdio.conf` can contain javascript. Since you probably do not want to permanently change your timeout value to 1 day, it can be often helpful to change these settings from the command line using an environment variable. This can used to dynamically change the configuration:


``` ```
var debug = process.env.DEBUG; var debug = process.env.DEBUG;
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/testrunner/frameworks.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ jasmineNodeOpts: {


Please note that you can't stop the test execution to do something async. It might happen that Please note that you can't stop the test execution to do something async. It might happen that
the command takes too much time and the website state has changed. Though usually after 2 another the command takes too much time and the website state has changed. Though usually after 2 another
commands the screenshot got taken which gives you still valueable information about the error. commands the screenshot got taken which gives you still valuable information about the error.


## Using Cucumber ## Using Cucumber


Expand Down
2 changes: 1 addition & 1 deletion docs/guide/testrunner/gettingstarted.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Options:
--key, -k corresponding access key to the user --key, -k corresponding access key to the user
--logLevel, -l Level of test output verbosity --logLevel, -l Level of test output verbosity
--coloredLogs, -c if true enables colors for log output (default: true) --coloredLogs, -c if true enables colors for log output (default: true)
--screenshotPath, -s saves a screenshot to a given path if a command failes --screenshotPath, -s saves a screenshot to a given path if a command fails
--baseUrl, -b shorten url command calls by setting a base url --baseUrl, -b shorten url command calls by setting a base url
--waitforTimeout, -w Default timeout for all wait commands --waitforTimeout, -w Default timeout for all wait commands
--framework, -f defines the framework (Mocha, Jasmine or Cucumber) to run the specs (default: mocha) --framework, -f defines the framework (Mocha, Jasmine or Cucumber) to run the specs (default: mocha)
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/usage/cloudservices.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Browserstack is also supported easily.


The only requirement is to set the `user` and `key` in your config (either exported by `wdio.conf.js` or passed into `webdriverio.remote(...)`) to your Browserstack automate username and access key. The only requirement is to set the `user` and `key` in your config (either exported by `wdio.conf.js` or passed into `webdriverio.remote(...)`) to your Browserstack automate username and access key.


You can also pass in any optional [supported capabilites](https://www.browserstack.com/automate/capabilities) as a key/value in the capabilities for any browser. If you set `browserstack.debug` to `true` it will record a screencast of the session, which might be helpful. You can also pass in any optional [supported capabilities](https://www.browserstack.com/automate/capabilities) as a key/value in the capabilities for any browser. If you set `browserstack.debug` to `true` it will record a screencast of the session, which might be helpful.


### [Local Testing](https://www.browserstack.com/local-testing#command-line) ### [Local Testing](https://www.browserstack.com/local-testing#command-line)


Expand Down Expand Up @@ -115,7 +115,7 @@ build: 'myApp #' + process.env.TRAVIS_BUILD_NUMBER + '.' + process.env.TRAVIS_JO


The only requirement is to set the `user` and `key` in your config (either exported by `wdio.conf.js` or passed into `webdriverio.remote(...)`) to your TestingBot username and secret key. The only requirement is to set the `user` and `key` in your config (either exported by `wdio.conf.js` or passed into `webdriverio.remote(...)`) to your TestingBot username and secret key.


You can also pass in any optional [supported capabilites](https://testingbot.com/support/other/test-options) as a key/value in the capabilities for any browser. You can also pass in any optional [supported capabilities](https://testingbot.com/support/other/test-options) as a key/value in the capabilities for any browser.


### [Local Testing](https://testingbot.com/support/other/tunnel) ### [Local Testing](https://testingbot.com/support/other/tunnel)


Expand Down
4 changes: 2 additions & 2 deletions docs/guide/usage/eventhandling.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ WebdriverIO events.


```js ```js
browser.on('error', function(e) { browser.on('error', function(e) {
// will be executed everytime an error occured // will be executed everytime an error occurred
// e.g. when element couldn't be found // e.g. when element couldn't be found
console.log(e.body.value.class); // -> "org.openqa.selenium.NoSuchElementException" console.log(e.body.value.class); // -> "org.openqa.selenium.NoSuchElementException"
console.log(e.body.value.message); // -> "no such element ..." console.log(e.body.value.message); // -> "no such element ..."
Expand All @@ -39,7 +39,7 @@ All commands are chainable, so you can use them while chaining your commands


```js ```js
var cnt; var cnt;

browser browser
.init() .init()
.once('countme', function(e) { .once('countme', function(e) {
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/selectors.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ To query an element with a specific tag name use `<tag>` or `<tag />`


## Name Attribute ## Name Attribute


For querying elements with a specific name attribute you can eather use a normal CSS3 selector or the For querying elements with a specific name attribute you can either use a normal CSS3 selector or the
provided name strategy from the JsonWireProtocol by passing something like `[name="some-name"]` as provided name strategy from the JsonWireProtocol by passing something like `[name="some-name"]` as
selector parameter selector parameter


Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ create your config file in less than a minute. It also gives and overview of all
<h2>Run your tests in the cloud</h2> <h2>Run your tests in the cloud</h2>
<p> <p>
Services like Sauce Labs or BrowserStack provide selenium testing on remote hosts. Services like Sauce Labs or BrowserStack provide selenium testing on remote hosts.
Be able to run tests on a wide collection of plattforms, devices and browser combinations Be able to run tests on a wide collection of platforms, devices and browser combinations
without any configuration in your enviroment. without any configuration in your environment.
</p> </p>
<div> <div>
<p>WebdriverIO supports services including:</p> <p>WebdriverIO supports services including:</p>
Expand Down
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ WebdriverIO Examples
==================== ====================


Welcome to the WebdriverIO example repository. Here you can find a lot of stuff that helps you to understand Welcome to the WebdriverIO example repository. Here you can find a lot of stuff that helps you to understand
how WebdriverIO works. It is seperated in different topics. The best way to start is to clone the WebdriverIO how WebdriverIO works. It is separated into different topics. The best way to start is to clone the WebdriverIO
repository and install its dependencies: repository and install its dependencies:


```sh ```sh
Expand All @@ -16,7 +16,7 @@ Then just follow the instructions and test it out. Have fun!
## Cloudservices ## Cloudservices


Shows you how to use WebdriverIO using Sauce Labs, Browserstack or Testingbot. To run those tests make sure Shows you how to use WebdriverIO using Sauce Labs, Browserstack or Testingbot. To run those tests make sure
you have your credentials stored in your enviroment. If so just execute the file using node: you have your credentials stored in your environment. If so just execute the file using node:


#### webdriverio.saucelabs.js #### webdriverio.saucelabs.js


Expand Down Expand Up @@ -57,7 +57,7 @@ Both browser will connect to each other and will have a two seconds long call.


#### webdriverio.multiremote.chat.js #### webdriverio.multiremote.chat.js


This example demonstrates how you could test a chat system. Both browser will connet to a text based chat. One browser will input something whereas the other browser reads the message, interprets it and returns with a proper response message. You can execute the test using Mocha. Make sure you pass a high timeout as argument to make the test work properly. This example demonstrates how you could test a chat system. Both browsers will connect to a text-based chat. One browser will input something whereas the other browser reads the message, interprets it and returns with a proper response message. You can execute the test using Mocha. Make sure you pass a high timeout as argument to make the test work properly.


```sh ```sh
./node_modules/.bin/mocha ./examples/multiremote/webdriverio.multiremote.chat.js --timeout 9999999 ./node_modules/.bin/mocha ./examples/multiremote/webdriverio.multiremote.chat.js --timeout 9999999
Expand Down
2 changes: 1 addition & 1 deletion examples/cloudservices/README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,7 +1,7 @@
# Cloudservices # Cloudservices


Shows you how to use WebdriverIO using Sauce Labs, Browserstack or Testingbot. To run those tests make sure Shows you how to use WebdriverIO using Sauce Labs, Browserstack or Testingbot. To run those tests make sure
you have your credentials stored in your enviroment. If so just execute the file using node: you have your credentials stored in your environment. If so just execute the file using node:


## webdriverio.saucelabs.js ## webdriverio.saucelabs.js


Expand Down

0 comments on commit 2bba792

Please sign in to comment.