Skip to content

Commit d68f7ae

Browse files
committed
Changed nargument names to valid identifers to avoid confusion
Argument names with whitespace like "jQuery object" are confusing, because it might easily be mistaken for two arguments when reading the signature. Argument names like "-index" are also confusing since they look like an expression rather than a name. I have renamed the argument names to be valid javascript identifiers, just like actual argument names have to be. Also changed argument type "Object" and "PlainObject" to "JQuery" where the prose documentation indicates that the type is a jQuery object.
1 parent 7455ae5 commit d68f7ae

File tree

11 files changed

+11
-11
lines changed

11 files changed

+11
-11
lines changed

entries/add.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</signature>
2222
<signature>
2323
<added>1.3.2</added>
24-
<argument name="jQuery object" type="jQuery">
24+
<argument name="jQueryObject" type="jQuery">
2525
<desc>An existing jQuery object to add to the set of matched elements.</desc>
2626
</argument>
2727
</signature>

entries/closest.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</signature>
2020
<signature>
2121
<added>1.6</added>
22-
<argument name="jQuery object" type="jQuery">
22+
<argument name="jQueryObject" type="jQuery">
2323
<desc>A jQuery object to match elements against.</desc>
2424
</argument>
2525
</signature>

entries/eq-selector.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<signature>
1212
<sample>:eq(-index)</sample>
1313
<added>1.8</added>
14-
<argument name="-index" type="Integer">
14+
<argument name="indexFromEnd" type="Integer">
1515
<desc>Zero-based index of the element to match, counting backwards from the last element. </desc>
1616
</argument>
1717
</signature>

entries/eq.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</signature>
1010
<signature>
1111
<added>1.4</added>
12-
<argument name="-index" type="Integer">
12+
<argument name="indexFromEnd" type="Integer">
1313
<desc>An integer indicating the position of the element, counting backwards from the last element in the set. </desc>
1414
</argument>
1515
</signature>

entries/filter.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</signature>
2424
<signature>
2525
<added>1.4</added>
26-
<argument name="jQuery object" type="Object">
26+
<argument name="jQueryObject" type="Object">
2727
<desc>An existing jQuery object to match the current set of elements against.</desc>
2828
</argument>
2929
</signature>

entries/find.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</signature>
1010
<signature>
1111
<added>1.6</added>
12-
<argument name="jQuery object" type="Object">
12+
<argument name="jQuery" type="jQuery">
1313
<desc>A jQuery object to match elements against.</desc>
1414
</argument>
1515
</signature>

entries/gt-selector.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<signature>
1212
<sample>:gt(-index)</sample>
1313
<added>1.8</added>
14-
<argument name="-index" type="Integer">
14+
<argument name="indexFromEnd" type="Integer">
1515
<desc>Zero-based index, counting backwards from the last element. </desc>
1616
</argument>
1717
</signature>

entries/is.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</signature>
1818
<signature>
1919
<added>1.6</added>
20-
<argument name="jQuery object" type="Object">
20+
<argument name="jQueryObject" type="Object">
2121
<desc>An existing jQuery object to match the current set of elements against.</desc>
2222
</argument>
2323
</signature>

entries/jQuery.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</signature>
3535
<signature>
3636
<added>1.0</added>
37-
<argument name="jQuery object" type="PlainObject">
37+
<argument name="jQueryObject" type="jQuery">
3838
<desc>An existing jQuery object to clone.</desc>
3939
</argument>
4040
</signature>

entries/lt-selector.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<signature>
1212
<sample>:lt(-index)</sample>
1313
<added>1.8</added>
14-
<argument name="-index" type="Integer">
14+
<argument name="indexFromEnd" type="Integer">
1515
<desc>Zero-based index, counting backwards from the last element. </desc>
1616
</argument>
1717
</signature>

entries/not.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
</signature>
2424
<signature>
2525
<added>1.4</added>
26-
<argument name="jQuery object" type="PlainObject">
26+
<argument name="jQueryObject" type="jQuery">
2727
<desc>An existing jQuery object to match the current set of elements against.</desc>
2828
</argument>
2929
</signature>

0 commit comments

Comments
 (0)