Amend docs for cursor::position (#674)
This commit is contained in:
parent
645685641a
commit
73a8ecc95f
@ -11,7 +11,10 @@ use crate::{
|
|||||||
|
|
||||||
/// Returns the cursor position (column, row).
|
/// 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)> {
|
pub fn position() -> Result<(u16, u16)> {
|
||||||
if is_raw_mode_enabled() {
|
if is_raw_mode_enabled() {
|
||||||
read_position_raw()
|
read_position_raw()
|
||||||
|
Loading…
Reference in New Issue
Block a user