itsscb/ratatui
1
0
Fork 0
mirror of https://github.com/ratatui/ratatui.git synced 2025-10-02 07:21:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: sparkline docs / doc tests (#1437)

Browse Source
This commit is contained in:
Josh McKinney 2024-10-19 23:24:38 -07:00 committed by GitHub
parent 514d273875
commit 611086eba4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/widgets/sparkline.rs
View File

@ -47,7 +47,8 @@ use crate::{
/// ///
/// ``` /// ```
/// use ratatui::{ /// use ratatui::{
/// style::{Style, Stylize}, /// style::{Color, Style, Stylize},
/// symbols,
/// widgets::{Block, RenderDirection, Sparkline}, /// widgets::{Block, RenderDirection, Sparkline},
/// }; /// };
/// ///
@ -123,6 +124,8 @@ impl<'a> Sparkline<'a> {
/// your own type that implements [`Into<Style>`]). /// your own type that implements [`Into<Style>`]).
/// ///
/// The foreground corresponds to the bars while the background is everything else. /// The foreground corresponds to the bars while the background is everything else.
///
/// [`Color`]: crate::style::Color
#[must_use = "method moves the value of self and returns the modified value"] #[must_use = "method moves the value of self and returns the modified value"]
pub fn absent_value_style<S: Into<Style>>(mut self, style: S) -> Self { pub fn absent_value_style<S: Into<Style>>(mut self, style: S) -> Self {
self.absent_value_style = style.into(); self.absent_value_style = style.into();
@ -265,6 +268,8 @@ impl SparklineBar {
/// As well as the style of the sparkline, each [`SparklineBar`] may optionally set its own /// As well as the style of the sparkline, each [`SparklineBar`] may optionally set its own
/// style. If set, the style of the bar will be the style of the sparkline combined with /// style. If set, the style of the bar will be the style of the sparkline combined with
/// the style of the bar. /// the style of the bar.
///
/// [`Color`]: crate::style::Color
#[must_use = "method moves the value of self and returns the modified value"] #[must_use = "method moves the value of self and returns the modified value"]
pub fn style<S: Into<Option<Style>>>(mut self, style: S) -> Self { pub fn style<S: Into<Option<Style>>>(mut self, style: S) -> Self {
self.style = style.into(); self.style = style.into();