From 990bbf178f9ddc52ec75026e357fe54853bf533f Mon Sep 17 00:00:00 2001
From: Friz64 <friz64@protonmail.com>
Date: Sat, 24 Feb 2024 23:15:38 +0100
Subject: [PATCH] Update documentation regarding `set_cursor_position` (#3521)

---
 src/window.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/window.rs b/src/window.rs
index a8533ba3..95ec1261 100644
--- a/src/window.rs
+++ b/src/window.rs
@@ -1353,7 +1353,8 @@ impl Window {
     ///
     /// ## Platform-specific
     ///
-    /// - **iOS / Android / Web / Wayland / Orbital:** Always returns an [`ExternalError::NotSupported`].
+    /// - **Wayland**: Cursor must be in [`CursorGrabMode::Locked`].
+    /// - **iOS / Android / Web / Orbital:** Always returns an [`ExternalError::NotSupported`].
     #[inline]
     pub fn set_cursor_position<P: Into<Position>>(&self, position: P) -> Result<(), ExternalError> {
         let position = position.into();
@@ -1361,7 +1362,7 @@ impl Window {
             .maybe_wait_on_main(|w| w.set_cursor_position(position))
     }
 
-    /// Set grabbing [mode]([`CursorGrabMode`]) on the cursor preventing it from leaving the window.
+    /// Set grabbing [mode](CursorGrabMode) on the cursor preventing it from leaving the window.
     ///
     /// # Example
     ///