From 155c41c7af67e37f1f69033007b68ec9b765e521 Mon Sep 17 00:00:00 2001 From: Mathieu Scheltienne Date: Tue, 3 Dec 2024 16:30:17 +0100 Subject: [PATCH] fix docstring --- stimuli/keyboard/_utils.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/stimuli/keyboard/_utils.py b/stimuli/keyboard/_utils.py index 25143f4..5bc0a9e 100644 --- a/stimuli/keyboard/_utils.py +++ b/stimuli/keyboard/_utils.py @@ -9,7 +9,7 @@ class KeyEvent: """Object representing a keyboard event. - Attributes + Parameters ---------- key : str The string representation of the key. @@ -20,6 +20,8 @@ class KeyEvent: Notes ----- + The parameters are accessible as attributes of the object. + The time reference is ``t0``, the instantiation time of the :class:`~stimuli.keyboard.Keyboard` object or the reset with :meth:`~stimuli.keyboard.Keyboard.reset`.