Skip to content

Commit

Permalink
docs: Improve clarity in documentation for Frame
Browse files Browse the repository at this point in the history
  • Loading branch information
kdheepak committed Sep 29, 2023
1 parent 11076d0 commit 2ed7019
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/terminal.rs
Expand Up @@ -546,10 +546,9 @@ fn compute_inline_size<B: Backend>(
/// This is obtained via the closure argument of [`Terminal::draw`]. It is used to render widgets
/// to the terminal and control the cursor position.
///
/// The changes drawn to the frame are not immediately applied to the terminal. They are only
/// applied after the closure returns. This allows for widgets to be drawn in any order. The
/// changes are then compared to the previous frame and only the necessary updates are applied to
/// the terminal.
/// The changes drawn to the frame are not immediately applied to the terminal. The changes are
/// accumulated in a buffer. After the closure returns, the changes are compared to the previous
/// frame and only the necessary updates are applied to the terminal.
///
/// The [`Frame`] is generic over a [`Backend`] implementation which is used to interface with the
/// underlying terminal library. The [`Backend`] trait is implemented for three popular Rust
Expand Down

0 comments on commit 2ed7019

Please sign in to comment.