oxwm

https://git.tonybtw.com/oxwm.git git://git.tonybtw.com/oxwm.git

Added comments to help contributors when adding keyactions.

Commit
46596a9c4662fd19b4b49cfd9bed449c10d044d4
Parent
35f6061
Author
tonybtw <tonybtw@tonybtw.com>
Date
2025-12-15 08:41:18

Diff

diff --git a/src/keyboard/handlers.rs b/src/keyboard/handlers.rs
index 9f6b841..4add040 100644
--- a/src/keyboard/handlers.rs
+++ b/src/keyboard/handlers.rs
@@ -7,6 +7,13 @@ use x11rb::protocol::xproto::*;
 use crate::errors::X11Error;
 use crate::keyboard::keysyms::{self, Keysym, format_keysym};
 
+/// When adding a new action, update:
+/// 1. Add variant here
+/// 2. lua_api.rs: string_to_action()
+/// 3. lua_api.rs: register_*_module()
+/// 4. window_manager.rs: handle_key_action()
+/// 5. (optionally) overlay/keybind.rs: action_description()
+/// 6. templates/oxwm.lua
 #[derive(Debug, Copy, Clone, Deserialize, PartialEq)]
 pub enum KeyAction {
     Spawn,