docs(terminal): add docs for terminal module (#486)

- moves the impl Terminal block up to be closer to the type definition
ratatui · Sep 12, 2023 · 42f8169 · 42f8169
1 parent 1414fbc
commit 42f8169
Show file tree

Hide file tree

Showing 3 changed files with 280 additions and 101 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -191,6 +191,7 @@ pub mod terminal;
 pub mod text;
 pub mod widgets;
 
-pub use self::terminal::{Frame, Terminal, TerminalOptions, Viewport};
+#[doc(inline)]
+pub use self::terminal::{CompletedFrame, Frame, Terminal, TerminalOptions, Viewport};
 
 pub mod prelude;
diff --git a/src/prelude.rs b/src/prelude.rs
@@ -29,6 +29,6 @@ pub use crate::{
     layout::{self, Alignment, Constraint, Corner, Direction, Layout, Margin, Rect},
     style::{self, Color, Modifier, Style, Styled, Stylize},
     symbols::{self, Marker},
-    terminal::{self, Frame, Terminal, TerminalOptions, Viewport},
+    terminal::{CompletedFrame, Frame, Terminal, TerminalOptions, Viewport},
     text::{self, Line, Masked, Span, Text},
 };