chore: Apply suggestions

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

Author: Techassi

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

@@ -864,7 +864,7 @@ of other generated items, like the status struct (if used) or the version enum.
 
 ### `#[versioned(k8s(singular = "..."))]`
 
-Set the singular name. Defaults to lowercased .kind value.
+Set the singular name. Defaults to lowercased `kind` value.
 
 ### `#[versioned(k8s(plural = "..."))]`
 
@@ -943,7 +943,7 @@ pub struct FooSpec {
 
 # fn main() {
 let merged_crd = Foo::merged_crd(FooVersion::V1Beta1).unwrap();
-println!("{}", serde_yaml::to_string(&merged_crd).unwrap());
+println!("{yaml}", yaml = serde_yaml::to_string(&merged_crd).unwrap());
 # }
 ```
 

crates/stackable-versioned/CHANGELOG.md

@@ -7,8 +7,8 @@ All notable changes to this project will be documented in this file.
 ### Added
 
 - Add support for CRD conversions via ConversionReviews ([#1050]).
-  - Add new `try_convert` function to convert objects received via a ConversionReview
-  - Add new `enable_tracing` option to `#[versioned(k8s(options(...)))]`
+  - Add new `try_convert` function to convert objects received via a ConversionReview.
+  - Add new `enable_tracing` option to `#[versioned(k8s(options(...)))]`.
 - Implement basic ground work for downgrading custom resources ([#1033]).
   - Emit `From` implementations to downgrade custom resource specs.
   - Emit a status struct to be able to track values required during downgrades and upgrades of

crates/stackable-versioned/src/k8s.rs

@@ -50,13 +50,13 @@ pub enum ParseObjectError {
     #[snafu(display(r#"failed to find "apiVersion" field"#))]
     FieldNotPresent,
 
-    #[snafu(display(r#"the "apiVersion" field is not a string"#))]
+    #[snafu(display(r#"the "apiVersion" field must be a string"#))]
     FieldNotStr,
 
     #[snafu(display("encountered unknown object api version {api_version:?}"))]
     UnknownApiVersion { api_version: String },
 
-    #[snafu(display("failed to deserialize object from json"))]
+    #[snafu(display("failed to deserialize object from JSON"))]
     Deserialize { source: serde_json::Error },
 }