Replace Mouse.isDown docs

Until Mouse.left and Mouse.right are added as part of elm#43, it makes sense for the docs on package.elm-lang.org to be true to how the function works to avoid any confusion
ThomasWeiser · Aug 19, 2015 · 2bd9a2d · 2bd9a2d
1 parent d1a0345
commit 2bd9a2d
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/Mouse.elm b/src/Mouse.elm
@@ -36,8 +36,8 @@ y =
   Signal.map snd position
 
 
-{-| The current state of the left mouse-button.
-True when the button is down, and false otherwise. -}
+{-| The current state of the mouse
+True when any mouse button is down, and false otherwise. -}
 isDown : Signal Bool
 isDown =
   Native.Mouse.isDown