From 939c25ce1afa9c5f3a7870bd521f8548a5903cb2 Mon Sep 17 00:00:00 2001 From: Rekai Musuka Date: Mon, 15 Nov 2021 22:05:26 -0400 Subject: [PATCH] chore: update comment --- src/gui.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/gui.rs b/src/gui.rs index e52fa77..7dd5534 100644 --- a/src/gui.rs +++ b/src/gui.rs @@ -35,9 +35,9 @@ impl GuiState { } } -/// This is meant to serve as a Default value. Therefore this KeyboardInput should **always** represent an **unused** key -/// performing an **unused** action -/// +/// To avoid using an [Option] to keep track of user input from winit, +/// we can use a "default" value. However, in order for this to work the chosen "default" +/// value must be an **unused** key, so that it is ignored by the emulator. pub fn unused_key() -> KeyboardInput { #![allow(deprecated)]