From aa5fde533caede971c5f1285057867bb2e4a3277 Mon Sep 17 00:00:00 2001 From: ryan Date: Sat, 10 Feb 2024 01:39:35 -0500 Subject: [PATCH] keyfork-crossterm: fixup docs --- crates/util/keyfork-crossterm/src/cursor/sys/unix.rs | 2 +- crates/util/keyfork-crossterm/src/style.rs | 2 +- crates/util/keyfork-crossterm/src/style/types/colored.rs | 2 +- crates/util/keyfork-crossterm/src/terminal.rs | 2 +- crates/util/keyfork-crossterm/src/terminal/sys/unix.rs | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/util/keyfork-crossterm/src/cursor/sys/unix.rs b/crates/util/keyfork-crossterm/src/cursor/sys/unix.rs index 4734212..1220e2e 100644 --- a/crates/util/keyfork-crossterm/src/cursor/sys/unix.rs +++ b/crates/util/keyfork-crossterm/src/cursor/sys/unix.rs @@ -13,7 +13,7 @@ use crate::{ /// 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. +/// [`crossterm::event::read`](crate::event::read()) or [`crossterm::event::poll`](crate::event::poll) are being called. pub fn position() -> io::Result<(u16, u16)> { if is_raw_mode_enabled() { read_position_raw() diff --git a/crates/util/keyfork-crossterm/src/style.rs b/crates/util/keyfork-crossterm/src/style.rs index c11eb68..aad11f8 100644 --- a/crates/util/keyfork-crossterm/src/style.rs +++ b/crates/util/keyfork-crossterm/src/style.rs @@ -170,7 +170,7 @@ pub fn available_color_count() -> u16 { /// /// # Notes /// -/// crossterm supports NO_COLOR (https://no-color.org/) to disabled colored output. +/// crossterm supports NO_COLOR () to disabled colored output. /// /// This API allows applications to override that behavior and force colorized output /// even if NO_COLOR is set. diff --git a/crates/util/keyfork-crossterm/src/style/types/colored.rs b/crates/util/keyfork-crossterm/src/style/types/colored.rs index 57fcfd9..2236449 100644 --- a/crates/util/keyfork-crossterm/src/style/types/colored.rs +++ b/crates/util/keyfork-crossterm/src/style/types/colored.rs @@ -71,7 +71,7 @@ impl Colored { } /// Checks whether ansi color sequences are disabled by setting of NO_COLOR - /// in environment as per https://no-color.org/ + /// in environment as per pub fn ansi_color_disabled() -> bool { !std::env::var("NO_COLOR") .unwrap_or("".to_string()) diff --git a/crates/util/keyfork-crossterm/src/terminal.rs b/crates/util/keyfork-crossterm/src/terminal.rs index 09b231d..24872c4 100644 --- a/crates/util/keyfork-crossterm/src/terminal.rs +++ b/crates/util/keyfork-crossterm/src/terminal.rs @@ -199,7 +199,7 @@ pub struct WindowSize { /// Returns the terminal size `[WindowSize]`. /// /// The width and height in pixels may not be reliably implemented or default to 0. -/// For unix, https://man7.org/linux/man-pages/man4/tty_ioctl.4.html documents them as "unused". +/// For unix, documents them as "unused". /// For windows it is not implemented. pub fn window_size() -> io::Result { sys::window_size() diff --git a/crates/util/keyfork-crossterm/src/terminal/sys/unix.rs b/crates/util/keyfork-crossterm/src/terminal/sys/unix.rs index b5c103d..fbe4b0a 100644 --- a/crates/util/keyfork-crossterm/src/terminal/sys/unix.rs +++ b/crates/util/keyfork-crossterm/src/terminal/sys/unix.rs @@ -144,7 +144,7 @@ pub(crate) fn disable_raw_mode() -> io::Result<()> { /// Queries the terminal's support for progressive keyboard enhancement. /// /// 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. +/// [`crossterm::event::read`](crate::event::read()) or [`crossterm::event::poll`](crate::event::poll) are being called. #[cfg(feature = "events")] pub fn supports_keyboard_enhancement() -> io::Result { if is_raw_mode_enabled() {