docs: add v2 todo code reminders

charmbracelet · Aug 20, 2024 · 210358d · 210358d
1 parent 2635e2e
commit 210358d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/key_deprecated.go b/key_deprecated.go
@@ -38,6 +38,9 @@ import (
 // one character, though certain input method editors (most notably Chinese
 // IMEs) can input multiple runes at once.
 //
+// TODO(v2): Add a KeyMsg interface that incorporates all the key message
+// types.
+//
 // Deprecated: KeyMsg is deprecated in favor of KeyPressMsg and KeyReleaseMsg.
 type KeyMsg struct {
 	Type  KeyType

diff --git a/mouse_deprecated.go b/mouse_deprecated.go
@@ -4,7 +4,10 @@ package tea
 // update function when mouse activity occurs. Note that the mouse must first
 // be enabled in order for the mouse events to be received.
 //
-// Deprecated in favor of MouseClickMsg, MouseReleaseMsg, MouseWheelMsg, and
+// TODO(v2): Add a MouseMsg interface that incorporates all the mouse message
+// types.
+//
+// Deprecated: in favor of MouseClickMsg, MouseReleaseMsg, MouseWheelMsg, and
 // MouseMotionMsg.
 type MouseMsg struct {
 	X      int