Fix clippy::doc_markdown lints (#28)

linebender · Jul 21, 2024 · 90c8f52 · 90c8f52
1 parent 69d5704
commit 90c8f52
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/src/runtime/render.rs b/src/runtime/render.rs
@@ -231,7 +231,7 @@ struct DrawData {
     stroke: Option<fixed::Stroke>,
     brush: fixed::Brush,
     alpha: f64,
-    /// Range into ShapeBatch::geometries
+    /// Range into `ShapeBatch::geometries`
     geometry: Range<usize>,
 }
 
@@ -251,7 +251,7 @@ impl DrawData {
 
 #[derive(Clone, Debug)]
 struct GeometryData {
-    /// Range into ShapeBatch::elements
+    /// Range into `ShapeBatch::elements`
     elements: Range<usize>,
     transform: Affine,
 }

diff --git a/src/schema/layers/visual.rs b/src/schema/layers/visual.rs
@@ -106,7 +106,7 @@ pub struct VisualLayer {
     #[serde(rename = "tg")]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub tag_name: Option<String>,
-    /// This is deprecated in favour of transform_before_mask
+    /// This is deprecated in favour of `transform_before_mask`
     #[deprecated(note = "please use `transform_before_mask` instead")]
     #[serde(rename = "cp")]
     #[serde(skip_serializing_if = "Option::is_none")]

diff --git a/src/schema/shapes/shape_element.rs b/src/schema/shapes/shape_element.rs
@@ -5,7 +5,7 @@ use crate::schema::constants::blend_mode::BlendMode;
 use crate::schema::helpers::visual_object::VisualObject;
 use serde::{Deserialize, Serialize};
 
-/// Base class for all elements of ShapeLayer and Group
+/// Base class for all elements of `ShapeLayer` and `Group`
 #[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
 pub struct ShapeElement {
     #[serde(flatten)]

diff --git a/src/schema/shapes/stroke.rs b/src/schema/shapes/stroke.rs
@@ -26,7 +26,7 @@ pub struct StrokeShape {
     #[serde(rename = "ml")]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub miter_limit: Option<f64>,
-    /// Animatable alternative to miter_limit
+    /// Animatable alternative to `miter_limit`
     #[serde(rename = "ml2")]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub miter_limit_alt: Option<FloatValue>,