Skip to content

Commit 68d36a8

Browse files
authored
Draggable:Sortable: Clarity the helper description
Since the helper function is provided by the user, the docs cannot claim what it will return but what it must return. Closes gh-346
1 parent 1f704bc commit 68d36a8

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

entries/draggable.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
<desc>If set to <code>"clone"</code>, then the element will be cloned and the clone will be dragged.</desc>
100100
</type>
101101
<type name="Function">
102-
<desc>A function that will return a DOMElement to use while dragging.</desc>
102+
<desc>A function that must return a jQuery or DOMElement to use while dragging.</desc>
103103
</type>
104104
</option>
105105
<option name="iframeFix" default="false" example-value="true">

entries/sortable.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
<desc>If set to <code>"clone"</code>, then the element will be cloned and the clone will be dragged.</desc>
111111
</type>
112112
<type name="Function">
113-
<desc>A function that will return a DOMElement to use while dragging. The function receives the event and the element being sorted.</desc>
113+
<desc>A function that must return a jQuery or DOMElement to use while dragging. The function receives the event and the jQuery element being sorted.</desc>
114114
</type>
115115
</option>
116116
<option name="items" type="Selector" default='"> *"' example-value='"> li"'>

0 commit comments

Comments
 (0)