Improved doc for KeyEvent kind field (#739)

crossterm-rs · Jan 10, 2023 · bb48b93 · bb48b93
1 parent 81eb00f
commit bb48b93
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/event.rs b/src/event.rs
@@ -642,6 +642,8 @@ pub struct KeyEvent {
     /// Additional key modifiers.
     pub modifiers: KeyModifiers,
     /// Kind of event.
+    ///
+    /// Only set if [`KeyboardEnhancementFlags::REPORT_EVENT_TYPES`] has been enabled with [`PushKeyboardEnhancementFlags`].
     pub kind: KeyEventKind,
     /// Keyboard state.
     ///