style: format doc comments

Author: joshka

rustfmt.toml

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

tui-big-text/src/big_text.rs

@@ -34,7 +34,7 @@ use crate::PixelSize;
 ///         "World".blue().into(),
 ///         "=====".into(),
 ///     ])
-///    .build();
+///     .build();
 /// ```
 ///
 /// Renders:

tui-cards/README.md

@@ -10,7 +10,7 @@ A simple library to render playing cards in a terminal using tui-rs.
 use tui_cards::{Card, Rank, Suit};
 
 let card = Card::new(Rank::Ace, Suit::Spades);
-frame.render_widget(&card, area);
+frame.render_widget(&card, frame.area());
 ```
 
 ## Demo

tui-popup/README.md

@@ -16,18 +16,24 @@ The popup widget is a simple widget that renders a popup in the center of the sc
 ## Example
 
 ```rust
-use ratatui::prelude::*;
+use ratatui::{
+    style::{Style, Stylize},
+    Frame,
+};
 use tui_popup::Popup;
 
 fn render_popup(frame: &mut Frame) {
-    let popup = Popup::new("tui-popup demo", "Press any key to exit")
-       .style(Style::new().white().on_blue());
-    frame.render_widget(&popup, frame.size());
+    let popup = Popup::new("Press any key to exit")
+        .title("tui-popup demo")
+        .style(Style::new().white().on_blue());
+    frame.render_widget(&popup, frame.area());
 }
 ```
 
 ![demo](https://vhs.charm.sh/vhs-q5Kz0QP3zmrBlQ6dofjMh.gif)
 
+## Feature flags
+
 <!-- cargo-rdme end -->
 
 ## State

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-qrcode/src/lib.rs

@@ -120,8 +120,11 @@ use ratatui::{
 ///
 /// ```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");
@@ -259,7 +262,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);
@@ -278,8 +281,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/README.md

@@ -18,8 +18,9 @@ cargo add tui-scrollview
 
 ```rust
 use std::iter;
-use tui_scrollview::{ScrollView, ScrollViewState};
+
 use ratatui::{layout::Size, prelude::*, widgets::*};
+use tui_scrollview::{ScrollView, ScrollViewState};
 
 struct MyScrollableWidget;
 
@@ -49,7 +50,7 @@ impl StatefulWidget for MyScrollableWidget {
 ## Full Example
 
 A full example can be found in the [examples] directory.
-[scrollview.rs](https://github.com/joshka/tui-widgets/blob/main/tui-scrollview/examples/scrollview.rs)
+[scrollview.rs](https://github.com/joshka/tui-widgets/tree/main/tui-scrollview/examples/scrollview.rs)
 
 This example shows a scrollable view with two paragraphs of text, one for the line numbers and
 one for the text. On top of this a Gauge widget is rendered to show that this can be used in

tui-scrollview/src/lib.rs

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

tui-scrollview/src/scroll_view.rs

@@ -127,7 +127,8 @@ impl ScrollView {
     /// # use ratatui::{prelude::*, layout::Size, widgets::*};
     /// # 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;
@@ -146,7 +147,8 @@ impl ScrollView {
     /// # use ratatui::{prelude::*, layout::Size, widgets::*};
     /// # 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;
@@ -165,7 +167,8 @@ impl ScrollView {
     /// # use ratatui::{prelude::*, layout::Size, widgets::*};
     /// # 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;