doc: comment on init

almindor · Oct 3, 2023 · 1ed4f89 · 1ed4f89
1 parent 64174b3
commit 1ed4f89
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/mipidsi/src/builder.rs b/mipidsi/src/builder.rs
@@ -117,7 +117,8 @@ where
     ///
     /// Consumes the builder to create a new [Display] with an optional reset [OutputPin].
     /// Blocks using the provided [DelayUs] `delay_source` to perform the display initialization.
-    ///
+    /// The display will be awake ready to use, no need to call [Display::wake] after init.
+    /// 
     /// ### WARNING
     /// The reset pin needs to be in *high* state in order for the display to operate.
     /// If it wasn't provided the user needs to ensure this is the case.