From 80a1cebbbbe1cc282a6b46bceabf5234bcffedb4 Mon Sep 17 00:00:00 2001
From: speak <jesse.viikari@vincit.fi>
Date: Wed, 28 Apr 2021 21:26:47 +0000
Subject: [PATCH] Adds an alias mouse position -> cursor position (#2038)

This alias is to aid people finding the cursor_position function, as the mouse
pressed / moved functionality and naming likely primes people for thinking
of "mouse" before "cursor" when searching the api documentation.
---
 crates/bevy_window/src/window.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/crates/bevy_window/src/window.rs b/crates/bevy_window/src/window.rs
index fd4277780457e0..be3a6c0f992303 100644
--- a/crates/bevy_window/src/window.rs
+++ b/crates/bevy_window/src/window.rs
@@ -467,6 +467,7 @@ impl Window {
     }
 
     #[inline]
+    #[doc(alias = "mouse position")]
     pub fn cursor_position(&self) -> Option<Vec2> {
         self.cursor_position
     }