docs: typos & formats (#430)

Jinjiang · eddyerburgh · commit 510bb2f45e64 · 2018-02-14T08:07:55.000Z
* [docs][en] synced all table of contents

* [docs][en] some typos

* [docs][en] formats

* [docs][en] formats and typos
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -51,7 +51,7 @@
     * [text](api/wrapper/text.md)
     * [trigger](api/wrapper/trigger.md)
     * [update](api/wrapper/update.md)
-    * [visible](api/wrapper/visible.md)
+    * [isVisible](api/wrapper/isVisible.md)
   * [WrapperArray](api/wrapper-array/README.md)
     * [at](api/wrapper-array/at.md)
     * [contains](api/wrapper-array/contains.md)
@@ -66,7 +66,7 @@
     * [setProps](api/wrapper-array/setProps.md)
     * [trigger](api/wrapper-array/trigger.md)
     * [update](api/wrapper-array/update.md)
-    * [visible](api/wrapper-array/visible.md)
+    * [isVisible](api/wrapper-array/isVisible.md)
   * [components](api/components/README.md)
     * [TransitionStub](api/components/TransitionStub.md)
     * [TransitionGroupStub](api/components/TransitionGroupStub.md)
diff --git a/docs/en/api/README.md b/docs/en/api/README.md
@@ -35,7 +35,7 @@
   * [text](./wrapper/text.md)
   * [trigger](./wrapper/trigger.md)
   * [update](./wrapper/update.md)
-  * [visible](./wrapper/visible.md)
+  * [isVisible](./wrapper/isVisible.md)
 * [WrapperArray](./wrapper-array/README.md)
   * [at](./wrapper-array/at.md)
   * [contains](./wrapper-array/contains.md)
@@ -50,7 +50,7 @@
   * [setProps](./wrapper-array/setProps.md)
   * [trigger](./wrapper-array/trigger.md)
   * [update](./wrapper-array/update.md)
-  * [visible](./wrapper-array/visible.md)
+  * [isVisible](./wrapper-array/isVisible.md)
 * [components](./components/README.md)
   * [TransitionStub](./components/TransitionStub.md)
   * [TransitionGroupStub](./components/TransitionGroupStub.md)
diff --git a/docs/en/api/components/RouterLinkStub.md b/docs/en/api/components/RouterLinkStub.md
@@ -1,4 +1,4 @@
-# RouterLinkStub
+# `RouterLinkStub`
 
 A component to stub the Vue Router `router-link` component.
 
diff --git a/docs/en/api/components/TransitionGroupStub.md b/docs/en/api/components/TransitionGroupStub.md
@@ -1,4 +1,4 @@
-# TransitionGroupStub
+# `TransitionGroupStub`
 
 A component to stub the `transition-group` component. Instead of performing transitions asynchronously, it returns the child components synchronously.
 
diff --git a/docs/en/api/components/TransitionStub.md b/docs/en/api/components/TransitionStub.md
@@ -1,4 +1,4 @@
-# TransitionStub
+# `TransitionStub`
 
 A component to stub the `transition` component. Instead of performing transitions asynchronously, it returns the child component synchronously.
 
diff --git a/docs/en/api/wrapper-array/README.md b/docs/en/api/wrapper-array/README.md
@@ -1,4 +1,4 @@
-# WrapperArray
+# `WrapperArray`
 
 A `WrapperArray` is an object that contains an array of [`Wrappers`](../wrapper/README.md), and methods to test the `Wrappers`.
 
diff --git a/docs/en/api/wrapper-array/at.md b/docs/en/api/wrapper-array/at.md
@@ -1,4 +1,4 @@
-# at(index)
+# `at(index)`
 
 Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0).
 
diff --git a/docs/en/api/wrapper-array/contains.md b/docs/en/api/wrapper-array/contains.md
@@ -1,4 +1,4 @@
-# contains(selector)
+# `contains(selector)`
 
 Assert every wrapper in `WrapperArray` contains selector.
 
diff --git a/docs/en/api/wrapper-array/destroy.md b/docs/en/api/wrapper-array/destroy.md
@@ -1,4 +1,4 @@
-# destroy()
+# `destroy()`
 
 Destroys each Vue `Wrapper` in `WrapperArray`.
 
diff --git a/docs/en/api/wrapper-array/filter.md b/docs/en/api/wrapper-array/filter.md
@@ -1,4 +1,4 @@
-# filter(predicate)
+# `filter(predicate)`
 
 Filter `WrapperArray` with a predicate function on `Wrapper` objects.
 
diff --git a/docs/en/api/wrapper-array/is.md b/docs/en/api/wrapper-array/is.md
@@ -1,4 +1,4 @@
-# is(selector)
+# `is(selector)`
 
 Assert every `Wrapper` in `WrapperArray` DOM node or `vm` matches [selector](../selectors.md).
 
diff --git a/docs/en/api/wrapper-array/isEmpty.md b/docs/en/api/wrapper-array/isEmpty.md
@@ -1,4 +1,4 @@
-# isEmpty()
+# `isEmpty()`
 
 Assert every `Wrapper` in `WrapperArray` does not contain child node.
 
diff --git a/docs/en/api/wrapper-array/isVisible.md b/docs/en/api/wrapper-array/isVisible.md
@@ -1,4 +1,4 @@
-# visible()
+# `isVisible()`
 
 Assert every `Wrapper` in `WrapperArray` is visible.
 
@@ -11,7 +11,7 @@ This can be used to assert that a component is hidden by `v-show`.
 - **Example:**
 
 ```js
-import { mount } from 'vue-test-utils'
+import { mount } from '@vue/test-utils'
 import { expect } from 'chai'
 import Foo from './Foo.vue'
 
diff --git a/docs/en/api/wrapper-array/isVueInstance.md b/docs/en/api/wrapper-array/isVueInstance.md
@@ -1,4 +1,4 @@
-# isVueInstance()
+# `isVueInstance()`
 
 Assert every `Wrapper` in `WrapperArray` is Vue instance.
 
diff --git a/docs/en/api/wrapper-array/setData.md b/docs/en/api/wrapper-array/setData.md
@@ -1,4 +1,4 @@
-# setData(data)
+# `setData(data)`
 
 Sets `Wrapper` `vm` data and forces update on each `Wrapper` in `WrapperArray`.
 
diff --git a/docs/en/api/wrapper-array/setMethods.md b/docs/en/api/wrapper-array/setMethods.md
@@ -1,5 +1,4 @@
-
-# setMethods(methods)
+# `setMethods(methods)`
 
 Sets `Wrapper` `vm` methods and forces update on each `Wrapper` in `WrapperArray`.
 
diff --git a/docs/en/api/wrapper-array/setProps.md b/docs/en/api/wrapper-array/setProps.md
@@ -1,4 +1,4 @@
-# setProps(props)
+# `setProps(props)`
 
 Sets `Wrapper` `vm` props and forces update on each `Wrapper` in `WrapperArray`.
 
diff --git a/docs/en/api/wrapper-array/trigger.md b/docs/en/api/wrapper-array/trigger.md
@@ -1,4 +1,4 @@
-# trigger(eventName)
+# `trigger(eventName)`
 
 Triggers an event on every `Wrapper` in the `WrapperArray` DOM node.
 
diff --git a/docs/en/api/wrapper-array/update.md b/docs/en/api/wrapper-array/update.md
@@ -1,4 +1,4 @@
-# update()
+# `update()`
 
 Force root Vue component of each `Wrapper` in `WrapperArray` to re-render.
 
diff --git a/docs/en/api/wrapper/attributes.md b/docs/en/api/wrapper/attributes.md
@@ -1,4 +1,4 @@
-# attributes()
+# `attributes()`
 
 Returns `Wrapper` DOM node attribute object.
 
diff --git a/docs/en/api/wrapper/classes.md b/docs/en/api/wrapper/classes.md
@@ -1,4 +1,4 @@
-# classes()
+# `classes()`
 
 Return `Wrapper` DOM node classes.
 
diff --git a/docs/en/api/wrapper/destroy.md b/docs/en/api/wrapper/destroy.md
@@ -1,4 +1,4 @@
-# destroy()
+# `destroy()`
 
 Destroys a Vue component instance.
 
diff --git a/docs/en/api/wrapper/emitted.md b/docs/en/api/wrapper/emitted.md
@@ -1,4 +1,4 @@
-# emitted()
+# `emitted()`
 
 Return an object containing custom events emitted by the `Wrapper` `vm`.
 
diff --git a/docs/en/api/wrapper/emittedByOrder.md b/docs/en/api/wrapper/emittedByOrder.md
@@ -1,4 +1,4 @@
-# emittedByOrder()
+# `emittedByOrder()`
 
 Return an Array containing custom events emitted by the `Wrapper` `vm`.
 
diff --git a/docs/en/api/wrapper/exists.md b/docs/en/api/wrapper/exists.md
@@ -1,4 +1,4 @@
-# exists()
+# `exists()`
 
 Assert `Wrapper` or `WrapperArray` exists.
 
diff --git a/docs/en/api/wrapper/find.md b/docs/en/api/wrapper/find.md
@@ -1,4 +1,4 @@
-# find(selector)
+# `find(selector)`
 
 Returns [`Wrapper`](README.md) of first DOM node or Vue component matching selector.
 
diff --git a/docs/en/api/wrapper/findAll.md b/docs/en/api/wrapper/findAll.md
@@ -1,4 +1,4 @@
-# findAll(selector)
+# `findAll(selector)`
 
 Returns a [`WrapperArray`](../wrapper-array/README.md).
 
diff --git a/docs/en/api/wrapper/html.md b/docs/en/api/wrapper/html.md
@@ -1,4 +1,4 @@
-# html()
+# `html()`
 
 Returns HTML of `Wrapper` DOM node as a string.
 
diff --git a/docs/en/api/wrapper/is.md b/docs/en/api/wrapper/is.md
@@ -1,4 +1,4 @@
-# is(selector)
+# `is(selector)`
 
 Assert `Wrapper` DOM node or `vm` matches [selector](../selectors.md).
 
diff --git a/docs/en/api/wrapper/isEmpty.md b/docs/en/api/wrapper/isEmpty.md
@@ -1,4 +1,4 @@
-# isEmpty()
+# `isEmpty()`
 
 Assert `Wrapper` does not contain child node.
 
diff --git a/docs/en/api/wrapper/isVisible.md b/docs/en/api/wrapper/isVisible.md
@@ -1,4 +1,4 @@
-# isVisible()
+# `isVisible()`
 
 Assert `Wrapper` is visible.
 
@@ -11,7 +11,7 @@ This can be used to assert that a component is hidden by `v-show`.
 - **Example:**
 
 ```js
-import { mount } from 'vue-test-utils'
+import { mount } from '@vue/test-utils'
 import { expect } from 'chai'
 import Foo from './Foo.vue'
 
diff --git a/docs/en/api/wrapper/isVueInstance.md b/docs/en/api/wrapper/isVueInstance.md
@@ -1,4 +1,4 @@
-# isVueInstance()
+# `isVueInstance()`
 
 Assert `Wrapper` is Vue instance.
 
diff --git a/docs/en/api/wrapper/name.md b/docs/en/api/wrapper/name.md
@@ -1,4 +1,4 @@
-# name()
+# `name()`
 
 Returns component name if `Wrapper` contains a Vue instance, or the tag name of `Wrapper` DOM node if `Wrapper` does not contain a Vue instance.
 
diff --git a/docs/en/api/wrapper/props.md b/docs/en/api/wrapper/props.md
@@ -1,4 +1,4 @@
-# props()
+# `props()`
 
 Return `Wrapper` `vm` props object.
 
diff --git a/docs/en/api/wrapper/setData.md b/docs/en/api/wrapper/setData.md
@@ -1,4 +1,4 @@
-# setData(data)
+# `setData(data)`
 
 Sets `Wrapper` `vm` data and forces update.
 
diff --git a/docs/en/api/wrapper/setMethods.md b/docs/en/api/wrapper/setMethods.md
@@ -1,4 +1,4 @@
-# setMethods(methods)
+# `setMethods(methods)`
 
 Sets `Wrapper` `vm` methods and forces update.
 
diff --git a/docs/en/api/wrapper/setProps.md b/docs/en/api/wrapper/setProps.md
@@ -1,4 +1,4 @@
-# setProps(props)
+# `setProps(props)`
 
 - **Arguments:**
   - `{Object} props`
diff --git a/docs/en/api/wrapper/text.md b/docs/en/api/wrapper/text.md
@@ -1,4 +1,4 @@
-# text()
+# `text()`
 
 Returns text content of `Wrapper`.
 
diff --git a/docs/en/api/wrapper/trigger.md b/docs/en/api/wrapper/trigger.md
@@ -1,4 +1,4 @@
-# trigger(eventName)
+# `trigger(eventName)`
 
 Triggers an event on the `Wrapper` DOM node.
 
diff --git a/docs/en/api/wrapper/update.md b/docs/en/api/wrapper/update.md
@@ -1,4 +1,4 @@
-# update()
+# `update()`
 
 Force root Vue component to re-render.
 
diff --git a/docs/en/guides/testing-SFCs-with-karma.md b/docs/en/guides/testing-SFCs-with-karma.md
@@ -29,7 +29,7 @@ Next we need to define a test script in our `package.json`.
 
 ### Karma Configuration
 
-Create a karma.conf.js file in the index of the project:
+Create a `karma.conf.js` file in the index of the project:
 
 ```js
 // karma.conf.js
@@ -138,7 +138,7 @@ Install `karma-coverage`, `babel-plugin-istanbul`, and `cross-env`:
 npm install --save-dev karma-coverage cross-env
 ```
 
-We're going to use `cross-env` to set a `BABEL_ENV` environment variable. This way we can use babel-plugin-istanbul when we're compiling for our tests—we don't want to include `babel-plugin-istnabul` when we compile our production code:
+We're going to use `cross-env` to set a `BABEL_ENV` environment variable. This way we can use `babel-plugin-istanbul` when we're compiling for our tests—we don't want to include `babel-plugin-istnabul` when we compile our production code:
 
 ```
 npm install --save-dev babel-plugin-istanbul
@@ -160,7 +160,7 @@ Update your `.babelrc` file to use `babel-plugin-istanbul` when `BABEL_ENV` is s
 }
 ```
 
-Now update the karma.conf.js file to use coverage. Add `coverage` to the reporters array, and add a coverageReporter field:
+Now update the `karma.conf.js` file to use coverage. Add `coverage` to the `reporters` array, and add a `coverageReporter` field:
 
 ```js
 // karma.conf.js
diff --git a/docs/en/guides/using-with-vue-router.md b/docs/en/guides/using-with-vue-router.md
@@ -18,7 +18,7 @@ shallow(Component, {
 })
 ```
 
-> **Note:** Installing Vue Router on a localVue also adds `$route` and `$router` as read-only properties to a localVue. This means you can not use the `mocks` option to overwrite `$route` and `$router` when mounting a component using a localVue with VueRouter installed.
+> **Note:** Installing Vue Router on a `localVue` also adds `$route` and `$router` as read-only properties to a `localVue`. This means you can not use the `mocks` option to overwrite `$route` and `$router` when mounting a component using a `localVue` with Vue Router installed.
 
 ## Testing components that use `router-link` or `router-view`
 
diff --git a/docs/en/guides/using-with-vuex.md b/docs/en/guides/using-with-vuex.md
@@ -289,7 +289,7 @@ Getters, mutations, and actions are all JavaScript functions, so we can test the
 
 The benefit to testing getters, mutations, and actions separately is that your unit tests are detailed. When they fail, you know exactly what is wrong with your code. The downside is that you will need to mock Vuex funtions, like `commit` and `dispatch`. This can lead to a situation where your unit tests pass, but your production code fails because your mocks are incorrect.
 
-We'll create two test files, mutations.spec.js and getters.spec.js:
+We'll create two test files, `mutations.spec.js` and `getters.spec.js`:
 
 First, let's test the `increment` mutations:
 
@@ -338,7 +338,7 @@ The benefit of testing creating a running store instance is we don't have to moc
 
 The downside is that when a test breaks, it can be difficult to find where the problem is.
 
-Let's write a test. When we create a store, we'll use `localVue` to avoid polluting the Vue base constructor. The test creates a store using the store-config.js export:
+Let's write a test. When we create a store, we'll use `localVue` to avoid polluting the Vue base constructor. The test creates a store using the `store-config.js` export:
 
 ```js
 // store-config.spec.js
