diff --git a/mouse.c b/mouse.c index 8bd81aa41..bce3d33a4 100644 --- a/mouse.c +++ b/mouse.c @@ -76,7 +76,15 @@ static int miss_newindex_handler = LUA_REFNIL; /** * The `screen` under the cursor * @property screen - * @tparam screen screen + * @tparam screen|nil screen + * @propertytype nil This will only happen if `screen` is set to `off` in the + * modeline or command line options. It happens very early in the initialization + * before the screens are created. If you check the screen from a signal, then + * you should never have to worry about this. Another corner case where this + * *might* happen is if you use `fake_resize` to have a smaller area than the + * physical screen. + * @propertydefault It checks where the cursor is and match it to one of the + * screen `geometry`. */ /** Get the pointer position.