Apply suggestions from code review

Co-authored-by: Techassi <[email protected]>

Author: NickLarsenNZ

crates/stackable-versioned-macros/src/attrs/common/item.rs

@@ -202,7 +202,7 @@ impl ItemAttributes {
                 if renamed.iter().any(|r| *r.since == *deprecated.since) =>
             {
                 Err(Error::custom(
-                    "cannot be marked as `deprecated` and `renamed` in the same version",
+                    format!("{item_type} cannot be marked as `deprecated` and `renamed` in the same version"),
                 )
                 .with_span(item_ident))
             }
@@ -260,8 +260,8 @@ impl ItemAttributes {
     /// The following naming rules apply:
     ///
     /// - Fields or variants marked as deprecated need to include the
-    ///   'deprecated_' prefix in their name. The prefix must not be included
-    ///   for fields or variants which are not deprecated.
+    ///   deprecation prefix in their name. The prefix must not be included for
+    ///   fields or variants which are not deprecated.
     fn validate_item_name(&self, item_ident: &Ident, item_type: &ItemType) -> Result<(), Error> {
         let prefix = match item_type {
             ItemType::Field => DEPRECATED_FIELD_PREFIX,
@@ -290,14 +290,14 @@ impl ItemAttributes {
     ///
     /// The following naming rules apply:
     ///
-    /// - `deprecated` must not be set on items. Instead, the
-    ///   stackable-versioned method of deprecating items should be used.
+    /// - `deprecated` must not be set on items. Instead, use the `deprecated()`
+    ///   action of the `#[versioned()]` macro.
     fn validate_item_attributes(&self, item_attrs: &Vec<Attribute>) -> Result<(), Error> {
         for attr in item_attrs {
             for segment in &attr.path().segments {
                 if segment.ident == "deprecated" {
                     return Err(Error::custom("deprecation must be done using #[versioned(deprecated(since = \"VERSION\"))]")
-                        .with_span(&segment.ident.span()));
+                        .with_span(&attr.span()));
                 }
             }
         }

crates/stackable-versioned-macros/src/attrs/field.rs

@@ -31,10 +31,10 @@ pub(crate) struct FieldAttributes {
     // `Option<Ident>`, while for enum variants, the type is `Ident`.
     pub(crate) ident: Option<Ident>,
 
-    /// The original attributes for the field.
     // This must be named `attrs` for darling to populate it accordingly, and
     // cannot live in common because Vec<Attribute> is not implemented for
     // FromMeta.
+    /// The original attributes for the field.
     pub(crate) attrs: Vec<Attribute>,
 }
 

crates/stackable-versioned-macros/src/attrs/variant.rs

@@ -32,10 +32,10 @@ pub(crate) struct VariantAttributes {
     // `Option<Ident>`, while for enum variants, the type is `Ident`.
     pub(crate) ident: Ident,
 
-    /// The original attributes for the field.
     // This must be named `attrs` for darling to populate it accordingly, and
     // cannot live in common because Vec<Attribute> is not implemented for
     // FromMeta.
+    /// The original attributes for the field.
     pub(crate) attrs: Vec<Attribute>,
 }
 

crates/stackable-versioned-macros/src/codegen/common/item.rs

@@ -110,7 +110,7 @@ where
         let attrs = A::try_from(&item)?;
         attrs.validate_versions(container_attrs, &item)?;
 
-        // These are the attributes addde to the item outside of the macro.
+        // These are the attributes added to the item outside of the macro.
         let original_attributes = attrs.original_attributes().clone();
 
         // These are the versioned macro attrs that are common to all items.

crates/stackable-versioned-macros/src/codegen/common/mod.rs

@@ -33,7 +33,7 @@ pub(crate) struct ContainerVersion {
     /// The ident of the container.
     pub(crate) ident: Ident,
 
-    /// Store an additional doc-comment lines for this version.
+    /// Store additional doc-comment lines for this version.
     pub(crate) version_specific_docs: Vec<String>,
 }