doc: Add doctests that shows how Text can be created from Cow<str>

This commit is contained in:
Andrew Chin 2021-05-05 00:03:03 -04:00 committed by Florian Dehau
parent 703e41cd49
commit 24396d97ed

View file

@ -23,6 +23,7 @@ use unicode_width::UnicodeWidthStr;
/// # use tui::widgets::Cell;
/// # use tui::style::{Style, Modifier};
/// # use tui::text::{Span, Spans, Text};
/// # use std::borrow::Cow;
/// Cell::from("simple string");
///
/// Cell::from(Span::from("span"));
@ -33,6 +34,8 @@ use unicode_width::UnicodeWidthStr;
/// ]));
///
/// Cell::from(Text::from("a text"));
///
/// Cell::from(Text::from(Cow::Borrowed("hello")));
/// ```
///
/// You can apply a [`Style`] on the entire [`Cell`] using [`Cell::style`] or rely on the styling
@ -81,6 +84,16 @@ where
/// ]);
/// ```
///
/// You can also construct a row from any type that can be converted into [`Text`]:
/// ```rust
/// # use std::borrow::Cow;
/// # use tui::widgets::Row;
/// Row::new(vec![
/// Cow::Borrowed("hello"),
/// Cow::Owned("world".to_uppercase()),
/// ]);
/// ```
///
/// By default, a row has a height of 1 but you can change this using [`Row::height`].
#[derive(Debug, Clone, PartialEq, Default)]
pub struct Row<'a> {