Skip to content

Added structured types for higer order function parameters #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
esx wants to merge 10 commits into from
Closed

Added structured types for higer order function parameters #419

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b82bc18
Added structured types for higer order function parameters
esx Jan 18, 2014
d8093a5
Changed some argument type from XMLHttpRequest to jsXHR
esx Jan 18, 2014
0d7d9b3
Fixed spelling and changed 'ajaxOptions' to 'PlainObject'
esx Jan 18, 2014
7455ae5
Fix spelling in type attribute
esx Jan 18, 2014
d68f7ae
Changed nargument names to valid identifers to avoid confusion
esx Jan 19, 2014
41ce261
Changed argument name 'jQueryObject' to 'selection'
esx Jan 21, 2014
6aa5119
Some fixies in signatures
esx Feb 13, 2014
9d4aa93
Name fix
esx Feb 13, 2014
49a296c
Clarify jQuery.map
esx Feb 17, 2014
40db666
Signature fixes for $.each() and prop()
esx May 16, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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.
  • Loading branch information
@esx
esx committed Jan 19, 2014
commit d68f7aefa6dfa11aee3172c6f7cb4c92c5bb4a3e
2 changes: 1 addition & 1 deletion entries/add.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</signature>
<signature>
<added>1.3.2</added>
<argument name="jQuery object" type="jQuery">
<argument name="jQueryObject" type="jQuery">
Copy link
Copy Markdown
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I'm missing something, but I'm not seeing anything effect of this change.

<desc>An existing jQuery object to add to the set of matched elements.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/closest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
</signature>
<signature>
<added>1.6</added>
<argument name="jQuery object" type="jQuery">
<argument name="jQueryObject" type="jQuery">
<desc>A jQuery object to match elements against.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/eq-selector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<signature>
<sample>:eq(-index)</sample>
<added>1.8</added>
<argument name="-index" type="Integer">
<argument name="indexFromEnd" type="Integer">
Copy link
Copy Markdown
Member

@tjvantoll tjvantoll Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I'm missing something but I'm not seeing any effect of these name changes.

Copy link
Copy Markdown
Member

@scottgonzalez scottgonzalez Jan 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as "jQuery object" to "selection", this is just to produce valid variable names in the signatures.

<desc>Zero-based index of the element to match, counting backwards from the last element. </desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/eq.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</signature>
<signature>
<added>1.4</added>
<argument name="-index" type="Integer">
<argument name="indexFromEnd" type="Integer">
<desc>An integer indicating the position of the element, counting backwards from the last element in the set. </desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/filter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</signature>
<signature>
<added>1.4</added>
<argument name="jQuery object" type="Object">
<argument name="jQueryObject" type="Object">
<desc>An existing jQuery object to match the current set of elements against.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/find.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</signature>
<signature>
<added>1.6</added>
<argument name="jQuery object" type="Object">
<argument name="jQuery" type="jQuery">
<desc>A jQuery object to match elements against.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/gt-selector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<signature>
<sample>:gt(-index)</sample>
<added>1.8</added>
<argument name="-index" type="Integer">
<argument name="indexFromEnd" type="Integer">
<desc>Zero-based index, counting backwards from the last element. </desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/is.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</signature>
<signature>
<added>1.6</added>
<argument name="jQuery object" type="Object">
<argument name="jQueryObject" type="Object">
<desc>An existing jQuery object to match the current set of elements against.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/jQuery.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
</signature>
<signature>
<added>1.0</added>
<argument name="jQuery object" type="PlainObject">
<argument name="jQueryObject" type="jQuery">
<desc>An existing jQuery object to clone.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/lt-selector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<signature>
<sample>:lt(-index)</sample>
<added>1.8</added>
<argument name="-index" type="Integer">
<argument name="indexFromEnd" type="Integer">
<desc>Zero-based index, counting backwards from the last element. </desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/not.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</signature>
<signature>
<added>1.4</added>
<argument name="jQuery object" type="PlainObject">
<argument name="jQueryObject" type="jQuery">
<desc>An existing jQuery object to match the current set of elements against.</desc>
</argument>
</signature>
Expand Down