[window_manager]: Add docs for add_slot naming behaviour (fixes #147)

bczsalba · Aug 31, 2024 · f5a16d2 · f5a16d2
1 parent 0fb0518
commit f5a16d2
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/pytermgui/window_manager/layouts.py b/pytermgui/window_manager/layouts.py
@@ -285,7 +285,8 @@ def add_slot(  # pylint: disable=too-many-arguments
         """Adds a new slot to the layout.
 
         Args:
-            name: The name of the slot. Used for display purposes.
+            name: The **snakeified** name of the slot. A non-snake case name
+                will cause issues when trying to retrieve the slot (see GH#147).
             slot: An already instantiated `Slot` instance. If this is given,
                 the additional width & height arguments will be ignored.
             width: The width for the new slot. See below for special types.