public
/
keyfork
5
0
Fork 0
Code Issues 16 Pull Requests 1 Packages Projects Releases Wiki Activity

keyfork-crossterm: fixup docs

This commit is contained in:
Ryan Heywood 2024-02-10 01:39:35 -05:00
parent 2b8c90fcd5
commit aa5fde533c
Signed by: ryan
GPG Key ID: 8E401478A3FBEF72
5 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/util/keyfork-crossterm/src/cursor/sys/unix.rs
View File

@ -13,7 +13,7 @@ use crate::{
/// The top left cell is represented as `(0, 0)`. /// The top left cell is represented as `(0, 0)`.
/// ///
/// On unix systems, this function will block and possibly time out while /// 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)> { pub fn position() -> io::Result<(u16, u16)> {
if is_raw_mode_enabled() { if is_raw_mode_enabled() {
read_position_raw() read_position_raw()

2
crates/util/keyfork-crossterm/src/style.rs
View File

@ -170,7 +170,7 @@ pub fn available_color_count() -> u16 {
/// ///
/// # Notes /// # Notes
/// ///
/// crossterm supports NO_COLOR (https://no-color.org/) to disabled colored output. /// crossterm supports NO_COLOR (<https://no-color.org/>) to disabled colored output.
/// ///
/// This API allows applications to override that behavior and force colorized output /// This API allows applications to override that behavior and force colorized output
/// even if NO_COLOR is set. /// even if NO_COLOR is set.

2
crates/util/keyfork-crossterm/src/style/types/colored.rs
View File

@ -71,7 +71,7 @@ impl Colored {
} }
/// Checks whether ansi color sequences are disabled by setting of NO_COLOR /// Checks whether ansi color sequences are disabled by setting of NO_COLOR
/// in environment as per https://no-color.org/ /// in environment as per <https://no-color.org/>
pub fn ansi_color_disabled() -> bool { pub fn ansi_color_disabled() -> bool {
!std::env::var("NO_COLOR") !std::env::var("NO_COLOR")
.unwrap_or("".to_string()) .unwrap_or("".to_string())

2
crates/util/keyfork-crossterm/src/terminal.rs
View File

@ -199,7 +199,7 @@ pub struct WindowSize {
/// Returns the terminal size `[WindowSize]`. /// Returns the terminal size `[WindowSize]`.
/// ///
/// The width and height in pixels may not be reliably implemented or default to 0. /// 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, <https://man7.org/linux/man-pages/man4/tty_ioctl.4.html> documents them as "unused".
/// For windows it is not implemented. /// For windows it is not implemented.
pub fn window_size() -> io::Result<WindowSize> { pub fn window_size() -> io::Result<WindowSize> {
sys::window_size() sys::window_size()

2
crates/util/keyfork-crossterm/src/terminal/sys/unix.rs
View File

@ -144,7 +144,7 @@ pub(crate) fn disable_raw_mode() -> io::Result<()> {
/// Queries the terminal's support for progressive keyboard enhancement. /// Queries the terminal's support for progressive keyboard enhancement.
/// ///
/// On unix systems, this function will block and possibly time out while /// 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")] #[cfg(feature = "events")]
pub fn supports_keyboard_enhancement() -> io::Result<bool> { pub fn supports_keyboard_enhancement() -> io::Result<bool> {
if is_raw_mode_enabled() { if is_raw_mode_enabled() {