doc(widgets/clear): clarify usage of clear

fdehau · Jun 16, 2021 · fbd8344 · fbd8344
1 parent 8da5f74
commit fbd8344
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/widgets/clear.rs b/src/widgets/clear.rs
@@ -1,8 +1,9 @@
-use crate::buffer::Buffer;
-use crate::layout::Rect;
-use crate::widgets::Widget;
+use crate::{buffer::Buffer, layout::Rect, widgets::Widget};
 
-/// A widget to to clear/reset a certain area to allow overdrawing (e.g. for popups)
+/// A widget to clear/reset a certain area to allow overdrawing (e.g. for popups).
+///
+/// This widget **cannot be used to clear the terminal on the first render** as `tui` assumes the
+/// render area is empty. Use [`crate::Terminal::clear`] instead.
 ///
 /// # Examples
 ///