diff --git a/src/cursor/sys/unix.rs b/src/cursor/sys/unix.rs index bf89309..f610be1 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()