From b662bf772f0bba3d465e5edab4302534ee3b4807 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <elv1313@gmail.com>
Date: Sun, 21 Aug 2022 23:02:27 -0700
Subject: [PATCH] mouse: Update the property documentation.

---
 mouse.c | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

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.