chore: fixup doc comments

Author: joshka

bacon.toml

@@ -65,10 +65,17 @@ need_stdout = true
 allow_warnings = true
 
 [jobs.coverage]
-command = ["cargo", "llvm-cov", "--workspace", "--lcov", "--output-path", "target/lcov.info"]
+command = [
+    "cargo",
+    "llvm-cov",
+    "--workspace",
+    "--lcov",
+    "--output-path",
+    "target/lcov.info",
+]
 
 [jobs.format]
-command = ["cargo", "+nightly", "fmt", "--", "--check"]
+command = ["cargo", "+nightly", "fmt"]
 on_success = "back"
 
 [jobs.rdme]

rustfmt.toml

@@ -3,3 +3,5 @@ comment_width = 100
 group_imports = "StdExternalCrate"
 imports_granularity = "Crate"
 max_width = 100
+
+format_code_in_doc_comments = true

src/lib.rs

@@ -19,27 +19,21 @@
 #[cfg(feature = "big-text")]
 #[doc(inline)]
 pub use tui_big_text as big_text;
-
 #[cfg(feature = "box-text")]
 #[doc(inline)]
 pub use tui_box_text as box_text;
-
 #[cfg(feature = "cards")]
 #[doc(inline)]
 pub use tui_cards as cards;
-
 #[cfg(feature = "popup")]
 #[doc(inline)]
 pub use tui_popup as popup;
-
 #[cfg(feature = "prompts")]
 #[doc(inline)]
 pub use tui_prompts as prompts;
-
 #[cfg(feature = "qrcode")]
 #[doc(inline)]
 pub use tui_qrcode as qrcode;
-
 #[cfg(feature = "scrollview")]
 #[doc(inline)]
 pub use tui_scrollview as scrollview;

tui-big-text/examples/alignment.rs

@@ -1,8 +1,9 @@
 use color_eyre::Result;
 use ratatui::{
     layout::{Constraint, Layout, Offset},
-    prelude::{Frame, Stylize},
+    style::Stylize,
     text::Line,
+    Frame,
 };
 use tui_big_text::{BigText, PixelSize};
 

tui-big-text/examples/big_text.rs

@@ -1,8 +1,9 @@
 use color_eyre::Result;
 use ratatui::{
     layout::Offset,
-    prelude::{Frame, Style, Stylize},
+    style::{Style, Stylize},
     text::Line,
+    Frame,
 };
 use tui_big_text::BigText;
 

tui-big-text/examples/common/mod.rs

@@ -7,7 +7,7 @@ use crossterm::{
     terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
     ExecutableCommand,
 };
-use ratatui::prelude::CrosstermBackend;
+use ratatui::backend::CrosstermBackend;
 
 /// A type alias for the terminal
 type Terminal = ratatui::Terminal<CrosstermBackend<io::Stdout>>;

tui-big-text/examples/pixel_size.rs

@@ -1,5 +1,10 @@
 use color_eyre::Result;
-use ratatui::prelude::*;
+use ratatui::{
+    layout::{Constraint, Layout},
+    style::Stylize,
+    text::Line,
+    Frame,
+};
 use tui_big_text::{BigText, PixelSize};
 
 mod common;

tui-big-text/examples/stopwatch.rs

@@ -13,9 +13,15 @@ use crossterm::{
     terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
 };
 use futures::{FutureExt, StreamExt};
-// use futures::{select, FutureExt, StreamExt};
 use itertools::Itertools;
-use ratatui::{prelude::*, widgets::Paragraph};
+use ratatui::{
+    backend::CrosstermBackend,
+    layout::{Constraint, Layout, Rect},
+    style::{Style, Stylize},
+    text::{Line, Span},
+    widgets::Paragraph,
+    Frame, Terminal,
+};
 use strum::EnumIs;
 use tokio::select;
 use tui_big_text::BigText;

tui-big-text/src/big_text.rs

@@ -23,7 +23,7 @@ use crate::PixelSize;
 /// # Examples
 ///
 /// ```rust
-/// use ratatui::prelude::*;
+/// use ratatui::style::{Style, Stylize};
 /// use tui_big_text::{BigText, PixelSize};
 ///
 /// BigText::builder()
@@ -34,7 +34,7 @@ use crate::PixelSize;
 ///         "World".blue().into(),
 ///         "=====".into(),
 ///     ])
-///    .build();
+///     .build();
 /// ```
 ///
 /// Renders:

tui-big-text/src/lib.rs

@@ -27,7 +27,10 @@
 //! # Examples
 //!
 //! ```rust
-//! use ratatui::prelude::{Frame, Style, Stylize};
+//! use ratatui::{
+//!     style::{Style, Stylize},
+//!     Frame,
+//! };
 //! use tui_big_text::{BigText, PixelSize};
 //!
 //! fn render(frame: &mut Frame) {

tui-popup/examples/paragraph.rs

@@ -2,7 +2,9 @@ use color_eyre::Result;
 use lipsum::lipsum;
 use ratatui::{
     crossterm::event::{self, Event, KeyCode},
-    prelude::{Rect, Span, Style, Stylize, Text},
+    layout::Rect,
+    style::{Style, Stylize},
+    text::{Span, Text},
     widgets::{Paragraph, Wrap},
     Frame,
 };

tui-popup/examples/popup.rs

@@ -2,7 +2,8 @@ use color_eyre::Result;
 use lipsum::lipsum;
 use ratatui::{
     crossterm::event::{self, Event},
-    prelude::{Rect, Style, Stylize},
+    layout::Rect,
+    style::{Style, Stylize},
     widgets::{Paragraph, Wrap},
     Frame,
 };

tui-popup/examples/state.rs

@@ -2,9 +2,11 @@ use color_eyre::Result;
 use lipsum::lipsum;
 use ratatui::{
     crossterm::event::{self, Event, KeyCode, KeyEvent, KeyEventKind},
-    prelude::{Constraint, Frame, Layout, Rect, Style, Stylize, Text},
+    layout::{Constraint, Layout, Rect},
+    style::{Style, Stylize},
+    text::Text,
     widgets::{Paragraph, Wrap},
-    DefaultTerminal,
+    DefaultTerminal, Frame,
 };
 use tui_popup::{Popup, PopupState};
 

tui-popup/src/lib.rs

@@ -5,7 +5,10 @@
 //! # Example
 //!
 //! ```rust
-//! use ratatui::{Frame, style::{Style, Stylize}};
+//! use ratatui::{
+//!     style::{Style, Stylize},
+//!     Frame,
+//! };
 //! use tui_popup::Popup;
 //!
 //! fn render_popup(frame: &mut Frame) {

tui-popup/src/popup.rs

@@ -22,7 +22,11 @@ use crate::{KnownSize, PopupState};
 /// # Example
 ///
 /// ```rust
-/// use ratatui::{prelude::*, symbols::border};
+/// use ratatui::{
+///     style::{Style, Stylize},
+///     symbols::border,
+///     Frame,
+/// };
 /// use tui_popup::Popup;
 ///
 /// fn render_popup(frame: &mut Frame) {

tui-prompts/examples/multi_line.rs

@@ -9,11 +9,12 @@ use ratatui::{
         self,
         event::{self, Event, KeyEvent},
     },
-    prelude::*,
-    widgets::*,
+    layout::{Constraint, Direction, Layout, Rect},
+    widgets::{Block, Borders, Paragraph, Wrap},
+    Frame,
 };
 use tui::Tui;
-use tui_prompts::prelude::*;
+use tui_prompts::{FocusState, Prompt, State, TextPrompt, TextState};
 
 #[derive(Parser)]
 struct Cli {

tui-prompts/examples/text.rs

@@ -6,11 +6,13 @@ use clap::Parser;
 use color_eyre::Result;
 use ratatui::{
     crossterm::event::{self, Event, KeyEvent, KeyModifiers},
-    prelude::*,
-    widgets::*,
+    layout::{Constraint, Direction, Layout, Rect},
+    style::{Style, Stylize},
+    widgets::{Block, Borders, Paragraph, Wrap},
+    Frame,
 };
 use tui::Tui;
-use tui_prompts::prelude::*;
+use tui_prompts::{FocusState, Prompt, State, TextPrompt, TextRenderStyle, TextState};
 
 #[derive(Parser)]
 struct Cli {

tui-prompts/examples/tui/mod.rs

@@ -4,7 +4,7 @@ use std::{
 };
 
 use color_eyre::Result;
-use ratatui::{crossterm, prelude::*};
+use ratatui::{backend::CrosstermBackend, crossterm, Terminal};
 
 /// A wrapper around the terminal that enables raw mode on creation and disables it on drop.
 pub struct Tui {

tui-prompts/src/prompt.rs

@@ -199,10 +199,10 @@ pub trait State {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-
     use ratatui_core::style::Stylize;
 
+    use super::*;
+
     #[test]
     fn status_symbols() {
         assert_eq!(Status::Pending.symbol(), "?".cyan());

tui-prompts/src/text_prompt.rs

@@ -11,7 +11,7 @@ use ratatui_core::{
 };
 use ratatui_widgets::{block::Block, paragraph::Paragraph};
 
-use crate::prelude::*;
+use crate::{Prompt, State, TextState};
 
 // TODO style the widget
 // TODO style each element of the widget.

tui-prompts/src/text_state.rs

@@ -1,6 +1,6 @@
 use std::borrow::Cow;
 
-use crate::{prelude::*, State};
+use crate::{FocusState, State, Status};
 
 #[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
 pub struct TextState<'a> {

tui-qrcode/src/lib.rs

@@ -120,8 +120,11 @@ use ratatui_core::{
 ///
 /// ```no_run
 /// use qrcode::QrCode;
+/// use ratatui::{
+///     style::{Style, Stylize},
+///     Frame,
+/// };
 /// use tui_qrcode::{Colors, QrCodeWidget, QuietZone, Scaling};
-/// use ratatui::{Frame, style::{Style, Stylize}};
 ///
 /// fn render(frame: &mut Frame) {
 ///     let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
@@ -261,7 +264,7 @@ impl QrCodeWidget {
     ///
     /// ```
     /// use qrcode::QrCode;
-    /// use tui_qrcode::{QrCodeWidget, Colors};
+    /// use tui_qrcode::{Colors, QrCodeWidget};
     ///
     /// let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
     /// let widget = QrCodeWidget::new(qr_code).colors(Colors::Inverted);
@@ -280,8 +283,8 @@ impl QrCodeWidget {
     ///
     /// ```
     /// use qrcode::QrCode;
-    /// use tui_qrcode::QrCodeWidget;
     /// use ratatui::style::{Style, Stylize};
+    /// use tui_qrcode::QrCodeWidget;
     ///
     /// let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
     /// let style = Style::new().red().on_light_yellow();

tui-scrollview/src/lib.rs

@@ -16,8 +16,13 @@
 //!
 //! ```rust
 //! use std::iter;
+//!
+//! use ratatui::{
+//!     buffer::Buffer,
+//!     layout::{Rect, Size},
+//!     widgets::{Paragraph, StatefulWidget},
+//! };
 //! use tui_scrollview::{ScrollView, ScrollViewState};
-//! use ratatui::{layout::Size, prelude::*, widgets::*};
 //!
 //! struct MyScrollableWidget;
 //!

tui-scrollview/src/scroll_view.rs

@@ -19,7 +19,13 @@ use crate::ScrollViewState;
 /// # Examples
 ///
 /// ```rust
-/// use ratatui::{prelude::*, layout::Size, widgets::*};
+/// use ratatui::{
+///     buffer::Buffer,
+///     Frame,
+///     layout::{Size, Rect},
+///     widgets::{Paragraph, StatefulWidget, Widget},
+///     text::Line
+/// };
 /// use tui_scrollview::{ScrollView, ScrollViewState};
 ///
 /// # fn render(buf: &mut Buffer) {
@@ -46,7 +52,7 @@ use crate::ScrollViewState;
 /// # }
 /// // or if you're rendering in a terminal draw closure instead of from within another widget:
 /// # fn terminal_draw(frame: &mut Frame, scroll_view: ScrollView, state: &mut ScrollViewState) {
-/// frame.render_stateful_widget(scroll_view, frame.size(), state);
+/// frame.render_stateful_widget(scroll_view, frame.area(), state);
 /// # }
 /// ```
 #[derive(Debug, Default, Clone, Eq, PartialEq, Hash)]
@@ -106,7 +112,7 @@ impl ScrollView {
     /// # Examples
     ///
     /// ```rust
-    /// # use ratatui::{prelude::*, layout::Size, widgets::*};
+    /// # use ratatui::{text::Line, layout::{Rect, Size}, widgets::Widget};
     /// # use tui_scrollview::ScrollView;
     ///
     /// let mut scroll_view = ScrollView::new(Size::new(20, 20));
@@ -125,10 +131,11 @@ impl ScrollView {
     /// # Examples
     ///
     /// ```rust
-    /// # use ratatui::{prelude::*, layout::Size, widgets::*};
+    /// # use ratatui::{text::Line, layout::{Rect, Size}, widgets::Widget};
     /// # use tui_scrollview::{ScrollView, ScrollbarVisibility};
     ///
-    /// let mut scroll_view = ScrollView::new(Size::new(20, 20)).vertical_scrollbar_visibility(ScrollbarVisibility::Always);
+    /// let mut scroll_view = ScrollView::new(Size::new(20, 20))
+    ///     .vertical_scrollbar_visibility(ScrollbarVisibility::Always);
     /// ```
     pub fn vertical_scrollbar_visibility(mut self, visibility: ScrollbarVisibility) -> Self {
         self.vertical_scrollbar_visibility = visibility;
@@ -144,10 +151,11 @@ impl ScrollView {
     /// # Examples
     ///
     /// ```rust
-    /// # use ratatui::{prelude::*, layout::Size, widgets::*};
+    /// # use ratatui::{text::Line, layout::{Rect, Size}, widgets::Widget};
     /// # use tui_scrollview::{ScrollView, ScrollbarVisibility};
     ///
-    /// let mut scroll_view = ScrollView::new(Size::new(20, 20)).horizontal_scrollbar_visibility(ScrollbarVisibility::Never);
+    /// let mut scroll_view = ScrollView::new(Size::new(20, 20))
+    ///     .horizontal_scrollbar_visibility(ScrollbarVisibility::Never);
     /// ```
     pub fn horizontal_scrollbar_visibility(mut self, visibility: ScrollbarVisibility) -> Self {
         self.horizontal_scrollbar_visibility = visibility;
@@ -163,10 +171,11 @@ impl ScrollView {
     /// # Examples
     ///
     /// ```rust
-    /// # use ratatui::{prelude::*, layout::Size, widgets::*};
+    /// # use ratatui::{text::Line, layout::{Rect, Size}, widgets::Widget};
     /// # use tui_scrollview::{ScrollView, ScrollbarVisibility};
     ///
-    /// let mut scroll_view = ScrollView::new(Size::new(20, 20)).scrollbars_visibility(ScrollbarVisibility::Automatic);
+    /// let mut scroll_view =
+    ///     ScrollView::new(Size::new(20, 20)).scrollbars_visibility(ScrollbarVisibility::Automatic);
     /// ```
     pub fn scrollbars_visibility(mut self, visibility: ScrollbarVisibility) -> Self {
         self.vertical_scrollbar_visibility = visibility;