chore: Apply suggestions

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

Author: Techassi

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

@@ -39,6 +39,7 @@ where
         item: &I,
     ) -> Result<(), darling::Error> {
         // NOTE (@Techassi): Can we maybe optimize this a little?
+
         let mut errors = Error::accumulator();
 
         if let Some(added) = &self.common_attrs().added {

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

@@ -10,7 +10,7 @@ use crate::attrs::common::{ItemAttributes, ItemType};
 /// Data stored in this struct is validated using darling's `and_then` attribute.
 /// During darlings validation, it is not possible to validate that action
 /// versions match up with declared versions on the container. This validation
-/// can be done using the associated [`FieldAttributes::validate_versions`][1]
+/// can be done using the associated [`ValidateVersions::validate_versions`][1]
 /// function.
 ///
 /// Rules shared across fields and variants can be found [here][2].

crates/stackable-versioned-macros/src/codegen/chain.rs

@@ -16,7 +16,7 @@ where
 {
     /// Returns the values of keys which are neighbors of `key`.
     ///
-    /// Imagine a map which contains the following keys: 1, 3, 5. Calling this
+    /// Given a map which contains the following keys: 1, 3, 5. Calling this
     /// function with these keys, results in the following return values:
     ///
     /// - Key **0**: `(None, Some(1))`

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

@@ -11,7 +11,7 @@ use crate::{
     },
 };
 
-/// This trait describes versioned container items, fields ans variants in a
+/// This trait describes versioned container items, fields and variants in a
 /// common way.
 ///
 /// Shared functionality is implemented in a single place. Code which cannot be
@@ -60,7 +60,7 @@ pub(crate) trait Attributes {
     fn common_attrs(&self) -> &ItemAttributes;
 }
 
-/// This struct combines common common code for versioned fields and variants.
+/// This struct combines common code for versioned fields and variants.
 ///
 /// Most of the initial creation of a versioned field and variant are identical.
 /// Currently, the following steps are unified:
@@ -106,10 +106,11 @@ where
         let item_attrs = attrs.common_attrs_owned();
 
         // Constructing the action chain requires going through the actions
-        // starting at the end, because the base container always represents the
-        // latest (most up-to-date) version of that struct. That's why the
-        // following code needs to go through the actions in reverse order, as
-        // otherwise it is impossible to extract the item ident for each version.
+        // starting at the end, because the container definition always
+        // represents the latest (most up-to-date) version of that struct.
+        // That's why the following code needs to go through the actions in
+        // reverse order, as otherwise it is impossible to extract the item
+        // ident for each version.
 
         // Deprecating an item is always the last state an item can end up in.
         // For items which are not deprecated, the last change is either the

crates/stackable-versioned-macros/src/codegen/vstruct/field.rs

@@ -16,12 +16,14 @@ use crate::{
     },
 };
 
-/// A versioned field, which contains contains common [`Field`] data and a chain
-/// of actions.
+/// A versioned field, which contains common [`Field`] data and a chain of
+/// actions.
 ///
-/// The chain of action maps versions to an action and the appropriate field
-/// name. Additionally, the [`Field`] data can be used to forward attributes,
-/// generate documentation, etc.
+/// The chain of actions maps versions to an action and the appropriate field
+/// name.
+///
+/// Additionally, the [`Field`] data can be used to forward attributes, generate
+/// documentation, etc.
 #[derive(Debug)]
 pub(crate) struct VersionedField(VersionedItem<Field, FieldAttributes>);
 
@@ -129,8 +131,7 @@ impl VersionedField {
             }
             None => {
                 // If there is no chain of field actions, the field is not
-                // versioned and code generation is straight forward.
-                // Unversioned fields are always included in versioned structs.
+                // versioned and therefore included in all versions.
                 let field_ident = &self.inner.ident;
                 let field_type = &self.inner.ty;