chore: Add doc comment to validate_added_action function

Techassi · Techassi · commit f2670202edfc · 2024-11-22T13:20:28.000+01:00
diff --git a/crates/stackable-versioned-macros/src/attrs/item/mod.rs b/crates/stackable-versioned-macros/src/attrs/item/mod.rs
@@ -204,6 +204,9 @@ impl CommonItemAttributes {
         Ok(())
     }
 
+    /// This associated function is called by the top-level validation function
+    /// and validates that parameters provided to the `added` actions are
+    /// valid.
     fn validate_added_action(&self) -> Result<()> {
         // NOTE (@Techassi): Can the path actually be empty?
         if let Some(added) = &self.added {

Original file line number	Diff line number	Diff line change
`@@ -204,6 +204,9 @@ impl CommonItemAttributes {`
`204`	`204`	`Ok(())`
`205`	`205`	`}`
`206`	`206`
	`207`	`+ /// This associated function is called by the top-level validation function`
	`208`	+ /// and validates that parameters provided to the `added` actions are
	`209`	`+ /// valid.`
`207`	`210`	`fn validate_added_action(&self) -> Result<()> {`
`208`	`211`	`// NOTE (@Techassi): Can the path actually be empty?`
`209`	`212`	`if let Some(added) = &self.added {`