Skip to content

Commit eb43c5f

Browse files
jugglinmikescottgonzalez
jugglinmike
authored and
scottgonzalez
committed
Document array-accepting manipulation methods
Unit tests which assert this behavior: - append: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L291 - appendTo: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L506 - prepend: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L607 - prependTo: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L671 - before: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L739 - after: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L291 - insertBefore: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L784 - insertAfter: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L853 - replaceWith: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L988 - replaceAll: https://github.com/jquery/jquery/blob/410cf4ee6bd454fa7e2bb5dc37a0b051f15d3e96/test/unit/manipulation.js#L1031
1 parent 0a8d0f9 commit eb43c5f

10 files changed

+20
-9
lines changed

‎entries/after.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="content">
7-
<desc>HTML string, DOM element, or jQuery object to insert after each element in the set of matched elements.</desc>
7+
<desc>HTML string, DOM element, array of elements, or jQuery object to insert after each element in the set of matched elements.</desc>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
1112
</argument>
1213
<argument name="content" optional="true">

‎entries/append.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="content">
7-
<desc>DOM element, HTML string, or jQuery object to insert at the end of each element in the set of matched elements.</desc>
7+
<desc>DOM element, array of elements, HTML string, or jQuery object to insert at the end of each element in the set of matched elements.</desc>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
1112
</argument>
1213
<argument name="content" optional="true">

‎entries/appendTo.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="target">
7-
<desc>A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.</desc>
7+
<desc>A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.</desc>
88
<type name="Selector"/>
99
<type name="htmlString"/>
1010
<type name="Element"/>
11+
<type name="Array"/>
1112
<type name="jQuery"/>
1213
</argument>
1314
</signature>

‎entries/before.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="content">
7-
<desc>HTML string, DOM element, or jQuery object to insert before each element in the set of matched elements.</desc>
7+
<desc>HTML string, DOM element, array of elements, or jQuery object to insert before each element in the set of matched elements.</desc>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
1112
</argument>
1213
<argument name="content" optional="true">

‎entries/insertAfter.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="target">
7-
<desc>A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.</desc>
7+
<desc>A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.</desc>
88
<type name="Selector"/>
99
<type name="htmlString"/>
1010
<type name="Element"/>
11+
<type name="Array"/>
1112
<type name="jQuery"/>
1213
</argument>
1314
</signature>

‎entries/insertBefore.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<signature>
55
<added>1.0</added>
66
<argument name="target">
7-
<desc>A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.</desc>
7+
<desc>A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.</desc>
88
<type name="Selector"/>
99
<type name="htmlString"/>
1010
<type name="Element"/>
11+
<type name="Array"/>
1112
<type name="jQuery"/>
1213
</argument>
1314
</signature>

‎entries/prepend.xml

+2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@
77
<desc>DOM element, array of elements, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements.</desc>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
1112
</argument>
1213
<argument name="content" optional="true">
1314
<type name="htmlString"/>
1415
<type name="Element"/>
16+
<type name="Array"/>
1517
<type name="jQuery"/>
1618
<desc>One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert at the beginning of each element in the set of matched elements.</desc>
1719
</argument>

‎entries/prependTo.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77
<type name="Selector"/>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
11-
<desc>A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.</desc>
12+
<desc>A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.</desc>
1213
</argument>
1314
</signature>
1415
<desc>Insert every element in the set of matched elements to the beginning of the target.</desc>

‎entries/replaceAll.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
<signature>
55
<added>1.2</added>
66
<argument name="target">
7-
<desc>A selector string, jQuery object, or DOM element reference indicating which element(s) to replace.</desc>
7+
<desc>A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace.</desc>
88
<type name="Selector"/>
99
<type name="jQuery"/>
10+
<type name="Array"/>
1011
<type name="Element"/>
1112
</argument>
1213
</signature>

‎entries/replaceWith.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
<signature>
55
<added>1.2</added>
66
<argument name="newContent">
7-
<desc>The content to insert. May be an HTML string, DOM element, or jQuery object.</desc>
7+
<desc>The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object.</desc>
88
<type name="htmlString"/>
99
<type name="Element"/>
10+
<type name="Array"/>
1011
<type name="jQuery"/>
1112
</argument>
1213
</signature>

0 commit comments

Comments
 (0)