Skip to content

Commit 92b6130

Browse files
committed
Updated documentation to reflect changes to the handling of the special _super parameter.
1 parent 23c538f commit 92b6130

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,10 @@ functionality.
192192
When a plugin is instantiated the contents of *members* around bound to the plugin instance using a mechanism that
193193
provides the function with access to the plugin instance via the **this** keyword.
194194

195-
Additionally, this mechanism also ensures that when the function is called it receives an additional trailing parameter,
196-
referred to as **_super** in this documentation, that provides access to the function this function overrides. In the
197-
event that the function overrides nothing, **_super** is safe to call as it results in a no-op.
195+
Additionally, this mechanism also ensures that if the final parameter of a function is named **_super** then when the
196+
function is called the value for **_super** will be automatically populated with a reference to the function overriden
197+
by the called function, if such a overriden function exists. If not, then **_super** will be populated with a no-op and is
198+
thus safe to call anyway.
198199

199200
Also note that jQuery PluginCreator provides five base functions for new plugins. These functions are:
200201

0 commit comments

Comments
 (0)