From c0590a100dac4383fafc55f7571890f44c727983 Mon Sep 17 00:00:00 2001 From: Slack Coder Date: Wed, 21 Dec 2022 08:20:18 -0500 Subject: [PATCH] cli: Lightly document terminal::Table Help developers by giving a small description and example for its use. Signed-off-by: Slack Coder --- radicle-cli/src/terminal/table.rs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/radicle-cli/src/terminal/table.rs b/radicle-cli/src/terminal/table.rs index 9b8de017..4cc8f8f2 100644 --- a/radicle-cli/src/terminal/table.rs +++ b/radicle-cli/src/terminal/table.rs @@ -1,3 +1,19 @@ +//! Print column-aligned text to the console. +//! +//! Example: +//! ``` +//! use radicle_cli::terminal::table::*; +//! +//! let mut t = Table::new(TableOptions::default()); +//! t.push(["pest".to_string(), "biological control".to_string()]); +//! t.push(["aphid".to_string(), "lacewing".to_string()]); +//! t.push(["spider mite".to_string(), "ladybug".to_string()]); +//! t.render(); +//! // pest biological control +//! // aphid lacewing +//! // spider mite ladybug +//! ``` + use std::fmt::Write; use crate::terminal as term;