Improve some docs

emilk · Feb 2, 2024 · b1a17d9 · b1a17d9
1 parent 78a55b2
commit b1a17d9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/crates/egui_plot/src/items/mod.rs b/crates/egui_plot/src/items/mod.rs
@@ -910,7 +910,7 @@ impl Points {
         self
     }
 
-    /// Set the maximum extent of the marker around its position.
+    /// Set the maximum extent of the marker around its position, in ui points.
     #[inline]
     pub fn radius(mut self, radius: impl Into<f32>) -> Self {
         self.radius = radius.into();

diff --git a/crates/egui_plot/src/transform.rs b/crates/egui_plot/src/transform.rs
@@ -379,7 +379,9 @@ impl PlotTransform {
         [1.0 / self.dpos_dvalue_x(), 1.0 / self.dpos_dvalue_y()]
     }
 
-    /// width / height aspect ratio
+    /// scale.x/scale.y ratio.
+    ///
+    /// If 1.0, it means the scale factor is the same in both axes.
     fn aspect(&self) -> f64 {
         let rw = self.frame.width() as f64;
         let rh = self.frame.height() as f64;