From 78b21a508c8e317d520aed6d680899b0cb051c4a Mon Sep 17 00:00:00 2001 From: eddyerburgh Date: Tue, 15 Jan 2019 20:45:57 +0000 Subject: [PATCH 1/2] docs: remove arguments from headings --- docs/api/wrapper-array/at.md | 2 +- docs/api/wrapper-array/contains.md | 2 +- docs/api/wrapper-array/destroy.md | 2 +- docs/api/wrapper-array/filter.md | 2 +- docs/api/wrapper-array/is.md | 2 +- docs/api/wrapper-array/isEmpty.md | 2 +- docs/api/wrapper-array/isVisible.md | 2 +- docs/api/wrapper-array/isVueInstance.md | 2 +- docs/api/wrapper-array/setChecked.md | 2 +- docs/api/wrapper-array/setData.md | 2 +- docs/api/wrapper-array/setMethods.md | 2 +- docs/api/wrapper-array/setProps.md | 2 +- docs/api/wrapper-array/setValue.md | 2 +- docs/api/wrapper-array/trigger.md | 2 +- docs/api/wrapper/attributes.md | 2 +- docs/api/wrapper/classes.md | 2 +- docs/api/wrapper/contains.md | 2 +- docs/api/wrapper/destroy.md | 2 +- docs/api/wrapper/emitted.md | 2 +- docs/api/wrapper/emittedByOrder.md | 2 +- docs/api/wrapper/exists.md | 2 +- docs/api/wrapper/find.md | 2 +- docs/api/wrapper/findAll.md | 2 +- docs/api/wrapper/html.md | 2 +- docs/api/wrapper/is.md | 2 +- docs/api/wrapper/isEmpty.md | 2 +- docs/api/wrapper/isVisible.md | 2 +- docs/api/wrapper/isVueInstance.md | 2 +- docs/api/wrapper/name.md | 2 +- docs/api/wrapper/props.md | 2 +- docs/api/wrapper/setChecked.md | 2 +- docs/api/wrapper/setData.md | 2 +- docs/api/wrapper/setMethods.md | 2 +- docs/api/wrapper/setProps.md | 2 +- docs/api/wrapper/setSelected.md | 2 +- docs/api/wrapper/setValue.md | 2 +- docs/api/wrapper/text.md | 2 +- docs/api/wrapper/trigger.md | 2 +- 38 files changed, 38 insertions(+), 38 deletions(-) diff --git a/docs/api/wrapper-array/at.md b/docs/api/wrapper-array/at.md index d8b76a3c7..3a22e4b00 100644 --- a/docs/api/wrapper-array/at.md +++ b/docs/api/wrapper-array/at.md @@ -1,4 +1,4 @@ -## at(index) +## at Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item is at index 0). diff --git a/docs/api/wrapper-array/contains.md b/docs/api/wrapper-array/contains.md index a19ac4566..c20de04d9 100644 --- a/docs/api/wrapper-array/contains.md +++ b/docs/api/wrapper-array/contains.md @@ -1,4 +1,4 @@ -### contains(selector) +### contains Assert every wrapper in `WrapperArray` contains selector. diff --git a/docs/api/wrapper-array/destroy.md b/docs/api/wrapper-array/destroy.md index 2fe69172a..0e0c456db 100644 --- a/docs/api/wrapper-array/destroy.md +++ b/docs/api/wrapper-array/destroy.md @@ -1,4 +1,4 @@ -## destroy() +## destroy Destroys each Vue `Wrapper` in `WrapperArray`. diff --git a/docs/api/wrapper-array/filter.md b/docs/api/wrapper-array/filter.md index e3e8f163c..c81ad3aa9 100644 --- a/docs/api/wrapper-array/filter.md +++ b/docs/api/wrapper-array/filter.md @@ -1,4 +1,4 @@ -## filter(predicate) +## filter Filter `WrapperArray` with a predicate function on `Wrapper` objects. diff --git a/docs/api/wrapper-array/is.md b/docs/api/wrapper-array/is.md index adc203a34..fb50ef8c6 100644 --- a/docs/api/wrapper-array/is.md +++ b/docs/api/wrapper-array/is.md @@ -1,4 +1,4 @@ -## is(selector) +## is Assert every `Wrapper` in `WrapperArray` DOM node or `vm` matches [selector](../selectors.md). diff --git a/docs/api/wrapper-array/isEmpty.md b/docs/api/wrapper-array/isEmpty.md index 1909ef070..fd7895702 100644 --- a/docs/api/wrapper-array/isEmpty.md +++ b/docs/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/api/wrapper-array/isVisible.md b/docs/api/wrapper-array/isVisible.md index 0229eb6fb..90080cfff 100644 --- a/docs/api/wrapper-array/isVisible.md +++ b/docs/api/wrapper-array/isVisible.md @@ -1,4 +1,4 @@ -## isVisible() +## isVisible Assert every `Wrapper` in `WrapperArray` is visible. diff --git a/docs/api/wrapper-array/isVueInstance.md b/docs/api/wrapper-array/isVueInstance.md index 4a7eddc4f..126b796e8 100644 --- a/docs/api/wrapper-array/isVueInstance.md +++ b/docs/api/wrapper-array/isVueInstance.md @@ -1,4 +1,4 @@ -## isVueInstance() +## isVueInstance Assert every `Wrapper` in `WrapperArray` is Vue instance. diff --git a/docs/api/wrapper-array/setChecked.md b/docs/api/wrapper-array/setChecked.md index 34011cefc..f18ca1603 100644 --- a/docs/api/wrapper-array/setChecked.md +++ b/docs/api/wrapper-array/setChecked.md @@ -1,4 +1,4 @@ -## setChecked(checked) +## setChecked This method is an alias of the following code. diff --git a/docs/api/wrapper-array/setData.md b/docs/api/wrapper-array/setData.md index d8f4e1bb5..107552f3c 100644 --- a/docs/api/wrapper-array/setData.md +++ b/docs/api/wrapper-array/setData.md @@ -1,4 +1,4 @@ -## setData(data) +## setData Sets `Wrapper` `vm` data on each `Wrapper` in `WrapperArray`. diff --git a/docs/api/wrapper-array/setMethods.md b/docs/api/wrapper-array/setMethods.md index eb46e75fd..1845e71d2 100644 --- a/docs/api/wrapper-array/setMethods.md +++ b/docs/api/wrapper-array/setMethods.md @@ -1,4 +1,4 @@ -## setMethods(methods) +## setMethods Sets `Wrapper` `vm` methods and forces update on each `Wrapper` in `WrapperArray`. diff --git a/docs/api/wrapper-array/setProps.md b/docs/api/wrapper-array/setProps.md index 391aebc5d..0bc430481 100644 --- a/docs/api/wrapper-array/setProps.md +++ b/docs/api/wrapper-array/setProps.md @@ -1,4 +1,4 @@ -## setProps(props) +## setProps Sets `Wrapper` `vm` props and forces update on each `Wrapper` in `WrapperArray`. diff --git a/docs/api/wrapper-array/setValue.md b/docs/api/wrapper-array/setValue.md index f19552939..3cf3cd16d 100644 --- a/docs/api/wrapper-array/setValue.md +++ b/docs/api/wrapper-array/setValue.md @@ -1,4 +1,4 @@ -## setValue(value) +## setValue This method is an alias of the following code. diff --git a/docs/api/wrapper-array/trigger.md b/docs/api/wrapper-array/trigger.md index 132660516..ed63e3b9f 100644 --- a/docs/api/wrapper-array/trigger.md +++ b/docs/api/wrapper-array/trigger.md @@ -1,4 +1,4 @@ -## trigger(eventType [, options ]) +## trigger Triggers an event on every `Wrapper` in the `WrapperArray` DOM node. diff --git a/docs/api/wrapper/attributes.md b/docs/api/wrapper/attributes.md index 9ea0c70b6..d70a4d65f 100644 --- a/docs/api/wrapper/attributes.md +++ b/docs/api/wrapper/attributes.md @@ -1,4 +1,4 @@ -## attributes([key]) +## attributes Returns `Wrapper` DOM node attribute object. If `key` is provided, the value for the `key` will be returned. diff --git a/docs/api/wrapper/classes.md b/docs/api/wrapper/classes.md index b683060cf..e4ae1686d 100644 --- a/docs/api/wrapper/classes.md +++ b/docs/api/wrapper/classes.md @@ -1,4 +1,4 @@ -## classes([className]) +## classes Return `Wrapper` DOM node classes. diff --git a/docs/api/wrapper/contains.md b/docs/api/wrapper/contains.md index 1f96b2fab..0114151d3 100644 --- a/docs/api/wrapper/contains.md +++ b/docs/api/wrapper/contains.md @@ -1,4 +1,4 @@ -## contains(selector) +## contains Assert `Wrapper` contains an element or component matching [selector](../selectors.md). diff --git a/docs/api/wrapper/destroy.md b/docs/api/wrapper/destroy.md index 7e0dca260..6e923e6ee 100644 --- a/docs/api/wrapper/destroy.md +++ b/docs/api/wrapper/destroy.md @@ -1,4 +1,4 @@ -## destroy() +## destroy Destroys a Vue component instance. diff --git a/docs/api/wrapper/emitted.md b/docs/api/wrapper/emitted.md index ceaac14db..c55cb5726 100644 --- a/docs/api/wrapper/emitted.md +++ b/docs/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/api/wrapper/emittedByOrder.md b/docs/api/wrapper/emittedByOrder.md index 0849d7df7..758664d40 100644 --- a/docs/api/wrapper/emittedByOrder.md +++ b/docs/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/api/wrapper/exists.md b/docs/api/wrapper/exists.md index 891d60ceb..a48dc6c0d 100644 --- a/docs/api/wrapper/exists.md +++ b/docs/api/wrapper/exists.md @@ -1,4 +1,4 @@ -## exists() +## exists Assert `Wrapper` or `WrapperArray` exists. diff --git a/docs/api/wrapper/find.md b/docs/api/wrapper/find.md index f2734ebf7..73594f379 100644 --- a/docs/api/wrapper/find.md +++ b/docs/api/wrapper/find.md @@ -1,4 +1,4 @@ -## find(selector) +## find Returns `Wrapper` of first DOM node or Vue component matching selector. diff --git a/docs/api/wrapper/findAll.md b/docs/api/wrapper/findAll.md index 8720d84ee..99b410f9f 100644 --- a/docs/api/wrapper/findAll.md +++ b/docs/api/wrapper/findAll.md @@ -1,4 +1,4 @@ -## findAll(selector) +## findAll Returns a [`WrapperArray`](../wrapper-array/). diff --git a/docs/api/wrapper/html.md b/docs/api/wrapper/html.md index 439fc4e39..f9c3baac3 100644 --- a/docs/api/wrapper/html.md +++ b/docs/api/wrapper/html.md @@ -1,4 +1,4 @@ -## html() +## html Returns HTML of `Wrapper` DOM node as a string. diff --git a/docs/api/wrapper/is.md b/docs/api/wrapper/is.md index aa689a21f..cc4ccb840 100644 --- a/docs/api/wrapper/is.md +++ b/docs/api/wrapper/is.md @@ -1,4 +1,4 @@ -## is(selector) +## is Assert `Wrapper` DOM node or `vm` matches [selector](../selectors.md). diff --git a/docs/api/wrapper/isEmpty.md b/docs/api/wrapper/isEmpty.md index f24a543c2..f83548282 100644 --- a/docs/api/wrapper/isEmpty.md +++ b/docs/api/wrapper/isEmpty.md @@ -1,4 +1,4 @@ -## isEmpty() +## isEmpty Assert `Wrapper` does not contain child node. diff --git a/docs/api/wrapper/isVisible.md b/docs/api/wrapper/isVisible.md index 80e3ec091..d2456c18a 100644 --- a/docs/api/wrapper/isVisible.md +++ b/docs/api/wrapper/isVisible.md @@ -1,4 +1,4 @@ -## isVisible() +## isVisible Assert `Wrapper` is visible. diff --git a/docs/api/wrapper/isVueInstance.md b/docs/api/wrapper/isVueInstance.md index 0f0329c22..70a1d2f89 100644 --- a/docs/api/wrapper/isVueInstance.md +++ b/docs/api/wrapper/isVueInstance.md @@ -1,4 +1,4 @@ -## isVueInstance() +## isVueInstance Assert `Wrapper` is Vue instance. diff --git a/docs/api/wrapper/name.md b/docs/api/wrapper/name.md index 4bdb1ab11..458bae5cc 100644 --- a/docs/api/wrapper/name.md +++ b/docs/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/api/wrapper/props.md b/docs/api/wrapper/props.md index 813d552da..8f753d678 100644 --- a/docs/api/wrapper/props.md +++ b/docs/api/wrapper/props.md @@ -1,4 +1,4 @@ -## props([key]) +## props Return `Wrapper` `vm` props object. If `key` is provided, the value for the `key` will be returned. diff --git a/docs/api/wrapper/setChecked.md b/docs/api/wrapper/setChecked.md index e771538d3..8ac57b349 100644 --- a/docs/api/wrapper/setChecked.md +++ b/docs/api/wrapper/setChecked.md @@ -1,4 +1,4 @@ -## setChecked(checked) +## setChecked Sets checked value for input element of type checkbox or radio and updates `v-model` bound data. diff --git a/docs/api/wrapper/setData.md b/docs/api/wrapper/setData.md index 40bf823c7..2e47643d3 100644 --- a/docs/api/wrapper/setData.md +++ b/docs/api/wrapper/setData.md @@ -1,4 +1,4 @@ -## setData(data) +## setData Sets `Wrapper` `vm` data. diff --git a/docs/api/wrapper/setMethods.md b/docs/api/wrapper/setMethods.md index cdc04713b..a1f73dca2 100644 --- a/docs/api/wrapper/setMethods.md +++ b/docs/api/wrapper/setMethods.md @@ -1,4 +1,4 @@ -## setMethods(methods) +## setMethods Sets `Wrapper` `vm` methods and forces update. diff --git a/docs/api/wrapper/setProps.md b/docs/api/wrapper/setProps.md index 60a39e472..e72bf754f 100644 --- a/docs/api/wrapper/setProps.md +++ b/docs/api/wrapper/setProps.md @@ -1,4 +1,4 @@ -## setProps(props) +## setProps - **Arguments:** - `{Object} props` diff --git a/docs/api/wrapper/setSelected.md b/docs/api/wrapper/setSelected.md index 937191304..7f592c26f 100644 --- a/docs/api/wrapper/setSelected.md +++ b/docs/api/wrapper/setSelected.md @@ -1,4 +1,4 @@ -## setSelected() +## setSelected Selects an option element and updates `v-model` bound data. diff --git a/docs/api/wrapper/setValue.md b/docs/api/wrapper/setValue.md index df8cb1bde..af70ef1cd 100644 --- a/docs/api/wrapper/setValue.md +++ b/docs/api/wrapper/setValue.md @@ -1,4 +1,4 @@ -## setValue(value) +## setValue Sets value of a text-control input or select element and updates `v-model` bound data. diff --git a/docs/api/wrapper/text.md b/docs/api/wrapper/text.md index e2f764a1f..5fbe76f2c 100644 --- a/docs/api/wrapper/text.md +++ b/docs/api/wrapper/text.md @@ -1,4 +1,4 @@ -## text() +## text Returns text content of `Wrapper`. diff --git a/docs/api/wrapper/trigger.md b/docs/api/wrapper/trigger.md index df675564d..b6c17e9a1 100644 --- a/docs/api/wrapper/trigger.md +++ b/docs/api/wrapper/trigger.md @@ -1,4 +1,4 @@ -## trigger(eventType [, options ]) +## trigger Triggers an event on the `Wrapper` DOM node. From 6e9825b1d2af3cc8cf3b8a3d5b1dbf15fe0a1641 Mon Sep 17 00:00:00 2001 From: eddyerburgh Date: Tue, 15 Jan 2019 21:22:53 +0000 Subject: [PATCH 2/2] docs: use redirects --- docs/.vuepress/_redirects | 65 ++++++++++++++++++++++++--------------- 1 file changed, 40 insertions(+), 25 deletions(-) diff --git a/docs/.vuepress/_redirects b/docs/.vuepress/_redirects index fac8b530f..80f1a823f 100644 --- a/docs/.vuepress/_redirects +++ b/docs/.vuepress/_redirects @@ -5,29 +5,44 @@ /api/createLocalVue /api/#createlocalvue /api/config /api/#config -/api/wrapper/* /api/wrapper.html/#:splat -/api/wrapper-array/* /api/wrapper-array.html/#:splat +/api/wrapper/isvisible /api/wrapper/#isvisible +/api/wrapper/emitted /api/wrapper/#emitted +/api/wrapper/html /api/wrapper/#html +/api/wrapper/name /api/wrapper/#name +/api/wrapper/setProps /api/wrapper/#setprops +/api/wrapper/attributes /api/wrapper/#attributes +/api/wrapper/emittedByOrder /api/wrapper/#emittedbyorder +/api/wrapper/is /api/wrapper/#is +/api/wrapper/props /api/wrapper/#props +/api/wrapper/setSelected /api/wrapper/#setselected +/api/wrapper/classes /api/wrapper/#classes +/api/wrapper/exists /api/wrapper/#exists +/api/wrapper/isEmpty /api/wrapper/#isempty +/api/wrapper/setChecked /api/wrapper/#setchecked +/api/wrapper/setValue /api/wrapper/#setvalue +/api/wrapper/contains /api/wrapper/#contains +/api/wrapper/find /api/wrapper/#find +/api/wrapper/isVisible /api/wrapper/#isvisible +/api/wrapper/setData /api/wrapper/#setdata +/api/wrapper/text /api/wrapper/#text +/api/wrapper/destroy /api/wrapper/#destroy +/api/wrapper/findAll /api/wrapper/#findall +/api/wrapper/isVueInstance /api/wrapper/#isvueinstance +/api/wrapper/setMethods /api/wrapper/#setmethods +/api/wrapper/trigger /api/wrapper/#trigger + +/api/wrapper-array/destroy /api/wrapper-array/#destroy +/api/wrapper-array/isEmpty /api/wrapper-array/#isempty +/api/wrapper-array/setChecked /api/wrapper-array/#setchecked +/api/wrapper-array/setProps /api/wrapper-array/#setprops +/api/wrapper-array/at /api/wrapper-array/#at +/api/wrapper-array/filter /api/wrapper-array/#filter +/api/wrapper-array/isVisible /api/wrapper-array/#isvisible +/api/wrapper-array/setData /api/wrapper-array/#setdata +/api/wrapper-array/setValue /api/wrapper-array/#setvalue +/api/wrapper-array/contains /api/wrapper-array/#contains +/api/wrapper-array/is /api/wrapper-array/#is +/api/wrapper-array/isVueInstance /api/wrapper-array/#isvueinstance +/api/wrapper-array/setMethods /api/wrapper-array/#setmethods +/api/wrapper-array/trigger /api/wrapper-array/#trigger -/ja/api/mount /ja/api/#mount -/ja/api/shallowMount /ja/api/#shallowmount -/ja/api/createLocalVue /ja/api/#createlocalvue -/ja/api/config /ja/api/#config - -/ja/api/wrapper/* /ja/api/wrapper.html/#:splat -/ja/api/wrapper-array/* /ja/api/wrapper-array.html/#:splat - -/zh/api/mount /zh/api/#mount -/zh/api/shallowMount /zh/api/#shallowmount -/zh/api/createLocalVue /zh/api/#createlocalvue -/zh/api/config /zh/api/#config - -/zh/api/wrapper/* /zh/api/wrapper.html/#:splat -/zh/api/wrapper-array/* /zh/api/wrapper-array.html/#:splat - -/ru/api/mount /ru/api/#mount -/ru/api/shallowMount /ru/api/#shallowmount -/ru/api/createLocalVue /ru/api/#createlocalvue -/ru/api/config /ru/api/#config - -/ru/api/wrapper/* /ru/api/wrapper.html/#:splat -/ru/api/wrapper-array/* /ru/api/wrapper-array.html/#:splat