Better doc-strings

emilk · Sep 24, 2023 · 5566372 · 5566372
1 parent bad9db8
commit 5566372
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/crates/egui/src/data/output.rs b/crates/egui/src/data/output.rs
@@ -84,6 +84,8 @@ pub struct PlatformOutput {
     pub mutable_text_under_cursor: bool,
 
     /// Screen-space position of text edit cursor (used for IME).
+    ///
+    /// Iff `Some`, the user is editing text.
     pub text_cursor_pos: Option<crate::Pos2>,
 
     #[cfg(feature = "accesskit")]

diff --git a/crates/emath/src/rect.rs b/crates/emath/src/rect.rs
@@ -13,6 +13,10 @@ use crate::*;
 /// of `min` and `max` are swapped. These are usually a sign of an error.
 ///
 /// Normally the unit is points (logical pixels) in screen space coordinates.
+///
+/// `Rect` does NOT implement `Default`, because there is no obvious default value.
+/// [`Rect::ZERO`] may seem reasonable, but when used as a bounding box, [`Rect::NOTHING`]
+/// is a better default - so be explicit instead!
 #[repr(C)]
 #[derive(Clone, Copy, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]