Document the canvas and div

crates/gpui/src/element.rs

@@ -22,7 +22,7 @@
 //! # Implementing your own elements
 //!
 //! Elements are intended to be the low level, imperative API to GPUI. They are responsible for upholding,
-//! or breaking, GPUI's features as they deem nescessary. As an example, most GPUI elements are expected
+//! or breaking, GPUI's features as they deem necessary. As an example, most GPUI elements are expected
 //! to stay in the bounds that their parent element gives them. But with [`WindowContext::break_content_mask`],
 //! you can ignore this restriction and paint anywhere inside of the window's bounds. This is useful for overlays
 //! and popups and anything else that shows up 'on top' of other elements.

crates/gpui/src/elements/canvas.rs

@@ -2,6 +2,8 @@ use refineable::Refineable as _;
 
 use crate::{Bounds, Element, IntoElement, Pixels, Style, StyleRefinement, Styled, WindowContext};
 
+/// Construct a canvas element with the given paint callback.
+/// Useful for adding short term custom drawing to a view.
 pub fn canvas(callback: impl 'static + FnOnce(&Bounds<Pixels>, &mut WindowContext)) -> Canvas {
     Canvas {
         paint_callback: Some(Box::new(callback)),
@@ -9,6 +11,8 @@ pub fn canvas(callback: impl 'static + FnOnce(&Bounds<Pixels>, &mut WindowContex
     }
 }
 
+/// A canvas element, meant for accessing the low level paint API without defining a whole
+/// custom element
 pub struct Canvas {
     paint_callback: Option<Box<dyn FnOnce(&Bounds<Pixels>, &mut WindowContext)>>,
     style: StyleRefinement,

crates/gpui/src/gpui.rs

@@ -1,5 +1,3 @@
-#![deny(missing_docs)]
-
 #[macro_use]
 mod action;
 mod app;