docs(cli): mention IsTerminal in cli::printing

This commit is contained in:
Christoph J. Scherr 2024-06-28 14:40:50 +02:00
parent a79513d1db
commit 4278f4b5a7
2 changed files with 5 additions and 0 deletions

View File

@ -9,3 +9,4 @@ pub use dialoguer;
pub use indicatif; pub use indicatif;
pub use exitcode; pub use exitcode;
pub use human_panic; pub use human_panic;

View File

@ -3,6 +3,10 @@
//! This module provides functions for formatting content with borders and colors, printing them to the console. //! This module provides functions for formatting content with borders and colors, printing them to the console.
//! The functions in this module are designed to simplify the process of creating visually appealing //! The functions in this module are designed to simplify the process of creating visually appealing
//! output for CLI applications. //! output for CLI applications.
//!
//! Note that most of the utilities in this module are focused on communication with humans, not
//! with machines. Consider evaluating [std::io::IsTerminal] before using colorful, dynamic and bordered
//! printing.
use comfy_table::presets; use comfy_table::presets;
use comfy_table::{CellAlignment, ContentArrangement, Table}; use comfy_table::{CellAlignment, ContentArrangement, Table};