From 2ed7019ab179b369e73e3e90b34174a077081628 Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Thu, 28 Sep 2023 21:18:42 -0400 Subject: [PATCH] docs: Improve clarity in documentation for `Frame` --- src/terminal.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/terminal.rs b/src/terminal.rs index a0dedf8fc..c7b836177 100644 --- a/src/terminal.rs +++ b/src/terminal.rs @@ -546,10 +546,9 @@ fn compute_inline_size( /// 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