mouse: improve docs for show_cursor() (see #729)

open-cogsci · Nov 25, 2020 · 48f50e1 · 48f50e1
1 parent 8404fca
commit 48f50e1
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/openexp/_mouse/mouse.py b/openexp/_mouse/mouse.py
@@ -49,7 +49,7 @@ class Mouse(Backend):
 
 		[TOC]
 
-		## Things to know
+		## Things to know
 
 		### Creating a Mouse
 
@@ -192,8 +192,12 @@ def show_cursor(self, show=True):
 			Immediately changes the visibility of the mouse cursor.
 
 			__Note:__ In most cases, you will want to use the `visible`
-			[keyword][Response keywords], which changes the visibility during
-			response collection, that is, while `mouse.get_click()` is called.
+			keyword, which changes the visibility during response collection,
+			that is, while `mouse.get_click()` is called. Calling 
+			`show_cursor()` will not implicitly change the value of `visible`, 
+			which can lead to the somewhat unintuitive behavior that the cursor
+			is hidden as soon as `get_click()` is called.
+			
 
 		keywords:
 			show: