Skip to content
Browse files

Improved unbind documentation

  • Loading branch information...
1 parent c38a242 commit 4d7c088bc2bedc72b773fc45569e9e979c711d7a @davoclavo davoclavo committed Jul 9, 2012
Showing with 3 additions and 5 deletions.
  1. +3 −5 mousetrap.js
View
8 mousetrap.js
@@ -698,12 +698,10 @@ window.Mousetrap = (function() {
/**
* unbinds an event to mousetrap
*
- * can be a single key, a combination of keys separated with +,
- * a comma separated list of keys, an array of keys, or
- * a sequence of keys separated by spaces
- *
* the unbinding just sets the callback function of that keycombo as an empty function
- * and deletes the corresponding key in the _direct_map dict
+ * and deletes the corresponding key in the _direct_map dict.
+
+ * the keycombo+action has to be exactly the same as it was defined in the bind method
*
* @param {string|Array} keys
* @param {string} action - 'up' for keyup anything else assumes keydown

0 comments on commit 4d7c088

Please sign in to comment.
Something went wrong with that request. Please try again.