From 73a8ecc95f33b8e26db930eb77a11831390831a2 Mon Sep 17 00:00:00 2001
From: Garmelon <joscha@plugh.de>
Date: Thu, 30 Jun 2022 21:28:38 +0200
Subject: [PATCH] Amend docs for cursor::position (#674)

---
 src/cursor/sys/unix.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/cursor/sys/unix.rs b/src/cursor/sys/unix.rs
index bf893099..f610be10 100644
--- a/src/cursor/sys/unix.rs
+++ b/src/cursor/sys/unix.rs
@@ -11,7 +11,10 @@ use crate::{
 
 /// Returns the cursor position (column, row).
 ///
-/// The top left cell is represented `0,0`.
+/// The top left cell is represented as `(0, 0)`.
+///
+/// On unix systems, this function will block and possibly time out while
+/// [`crossterm::event::read`](crate::event::read) or [`crossterm::event::poll`](crate::event::poll) are being called.
 pub fn position() -> Result<(u16, u16)> {
     if is_raw_mode_enabled() {
         read_position_raw()