Merge pull request #296 from waywardmonkeys/improve-docs

docs: Small formatting improvements.

src/bezpath.rs

@@ -1361,7 +1361,7 @@ impl Shape for PathSeg {
 
     /// The area under the curve.
     ///
-    /// We could just return 0, but this seems more useful.
+    /// We could just return `0`, but this seems more useful.
     fn area(&self) -> f64 {
         self.signed_area()
     }

src/common.rs

@@ -302,7 +302,7 @@ fn solve_quartic_inner(a: f64, b: f64, c: f64, d: f64, rescale: bool) -> Option<
 
 /// Factor a quartic into two quadratics.
 ///
-/// Attempt to factor a quartic equation into two quadratic equations. Returns None either if there
+/// Attempt to factor a quartic equation into two quadratic equations. Returns `None` either if there
 /// is overflow (in which case rescaling might succeed) or the factorization would result in
 /// complex coefficients.
 ///

src/cubicbez.rs

@@ -161,7 +161,7 @@ impl CubicBez {
     /// Approximate a cubic with a single quadratic
     ///
     /// Returns a quadratic approximating the given cubic that maintains
-    /// endpoint tangents if that is within tolerance, or None otherwise.
+    /// endpoint tangents if that is within tolerance, or `None` otherwise.
     fn try_approx_quadratic(&self, accuracy: f64) -> Option<QuadBez> {
         if let Some(q1) = Line::new(self.p0, self.p1).crossing_point(Line::new(self.p2, self.p3)) {
             let c1 = self.p0.lerp(q1, 2.0 / 3.0);

src/fit.rs

@@ -281,7 +281,7 @@ impl CurveDist {
 
     /// Evaluate distance to a cubic approximation.
     ///
-    /// If distance exceeds stated accuracy, can return None. Note that
+    /// If distance exceeds stated accuracy, can return `None`. Note that
     /// `acc2` is the square of the target.
     ///
     /// Returns the squre of the error, which is intended to be a good

src/offset.rs

@@ -67,7 +67,7 @@ impl CubicOffset {
     /// Create a new curve from Bézier segment and offset.
     ///
     /// This method should only be used if the Bézier is smooth. Use
-    /// [`new_regularized`]instead to deal with a wider range of inputs.
+    /// [`new_regularized`] instead to deal with a wider range of inputs.
     ///
     /// [`new_regularized`]: Self::new_regularized
     pub fn new(c: CubicBez, d: f64) -> Self {

src/rounded_rect_radii.rs

@@ -74,15 +74,15 @@ impl RoundedRectRadii {
         )
     }
 
-    /// Returns true if all radius values are finite.
+    /// Returns `true` if all radius values are finite.
     pub fn is_finite(&self) -> bool {
         self.top_left.is_finite()
             && self.top_right.is_finite()
             && self.bottom_right.is_finite()
             && self.bottom_left.is_finite()
     }
 
-    /// Returns true if any corner radius value is NaN.
+    /// Returns `true` if any corner radius value is NaN.
     pub fn is_nan(&self) -> bool {
         self.top_left.is_nan()
             || self.top_right.is_nan()

src/svg.rs

@@ -33,7 +33,7 @@ pub struct SvgArc {
 }
 
 impl BezPath {
-    /// Create a BezPath with segments corresponding to the sequence of
+    /// Create a `BezPath` with segments corresponding to the sequence of
     /// `PathSeg`s
     pub fn from_path_segments(segments: impl Iterator<Item = PathSeg>) -> BezPath {
         let mut path_elements = Vec::new();