chore: Apply suggestions

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

Author: Techassi

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

@@ -318,7 +318,7 @@ fn default_default_fn() -> SpannedValue<Path> {
     )
 }
 
-// TODO (@Techassi): Add validation for when from_name AND from_type or both
+// TODO (@Techassi): Add validation for when from_name AND from_type are both
 // none => is this action needed in the first place?
 // TODO (@Techassi): Add validation that the from_name mustn't include the
 // deprecated prefix.

crates/stackable-versioned-macros/src/lib.rs

@@ -22,15 +22,21 @@ mod consts;
 /// ## Declaring Versions
 ///
 /// It is **important** to note that this macro must be placed before any other
-/// (derive) macros and attributes. This ensures that the macros and attributes
-/// are applied to the generated versioned instances of the struct or enum.
+/// (derive) macros and attributes. Macros supplied before the versioned macro
+/// will be erased, because the original struct or enum (container) is erased,
+/// and new containers are generated. This ensures that the macros and
+/// attributes are applied to the generated versioned instances of the
+/// container.
 ///
 /// Before any of the fields or variants can be versioned, versions need to be
 /// declared at the container level. Each version currently supports two
 /// parameters: `name` and the `deprecated` flag. The `name` must be a valid
-/// (and supported) format - currently, only Kubernetes API versions are
-/// supported. The macro checks each declared version and reports any error
-/// encountered during parsing.
+/// (and supported) format.
+///
+/// <div class="warning">
+/// Currently, only Kubernetes API versions are supported. The macro checks each
+/// declared version and reports any error encountered during parsing.
+/// </div>
 ///
 /// ```
 /// # use stackable_versioned_macros::versioned;
@@ -46,9 +52,9 @@ mod consts;
 /// 1. The `#[automatically_derived]` attribute indicates that the following
 ///    piece of code is automatically generated by a macro instead of being
 ///    handwritten by a developer. This information is used by cargo and rustc.
-/// 2. For each declared version, a new module containing the struct or enum
-///    (container) is generated. This enables you to reference the container by
-///    versions via `v1alpha1::Foo`.
+/// 2. For each declared version, a new module containing the container is
+///    generated. This enables you to reference the container by versions via
+///    `v1alpha1::Foo`.
 /// 3. This `use` statement gives the generated containers access to the imports
 ///    at the top of the file. This is a convenience, because otherwise you
 ///    would need to prefix used items with `super::`. Additionally, other
@@ -117,8 +123,8 @@ mod consts;
 ///
 /// ## Item Actions
 ///
-/// This library currently supports three different item actions. Items can
-/// be added, renamed and deprecated. The macro ensures that these actions
+/// This crate currently supports three different item actions. Items can
+/// be added, changed, and deprecated. The macro ensures that these actions
 /// adhere to the following set of rules:
 ///
 /// 1. Items cannot be added and deprecated in the same version.
@@ -366,15 +372,15 @@ mod consts;
 /// automatically generates `From` implementations. On a high level, code
 /// generated for two versions _a_ and _b_, with _a < b_ looks like this:
 /// `impl From<a> for b`. As you can see, only upgrading is currently supported.
-/// Downgrading, so going from a higher version to a lower one, is not supported
-/// at the moment.
+/// Downgrading from a higher version to a lower one is not supported at the
+/// moment.
 ///
 /// This automatic generation can be skipped to for example enable a custom
 /// implementation for more complex conversions.
 ///
 /// ### Skipping at the Container Level
 ///
-/// Disabling this feature on the container level results in no `From`
+/// Disabling this behavior at the container level results in no `From`
 /// implementation for all versions.
 ///
 /// ```
@@ -397,7 +403,7 @@ mod consts;
 ///
 /// ### Skipping at the Version Level
 ///
-/// Disabling this feature at the version level results in no `From`
+/// Disabling this behavior at the version level results in no `From`
 /// implementation for that particular version. This can be read as "skip
 /// generation for converting _this_ version to the next one". In the example
 /// below no conversion between version `v1beta1` and `v1` is generated.