chore: fix comments/descriptions in tests

Author: NickLarsenNZ

kube-core/src/schema/transform_optional_enum_with_null.rs

@@ -54,11 +54,12 @@ pub(crate) fn remove_optional_enum_null_variant(kube_schema: &mut SchemaObject)
 
     // It only makes sense to remove `null` enum values in case the enum is
     // nullable (thus optional).
-    if let Some(Value::Bool(true)) = extensions.get("nullable")
+    if let Some(Value::Bool(true)) = extensions.get("nullable") {
         // Don't remove the single last enum variant. This often happens for
         // `Option<XXX>`, which is represented as
         // `"anyOf": [XXX, {"enum": [null], "optional": true}]`
-        && enum_values.len() > 1 {
+        if enum_values.len() > 1 {
             enum_values.retain(|enum_value| enum_value != &Value::Null);
+        }
     }
 }

kube-derive/tests/crd_complex_enum_tests.rs

@@ -7,7 +7,7 @@ use serde_json::json;
 
 // Enum definitions
 
-/// A very simple enum with empty variants
+/// A very simple enum with unit variants
 #[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
 enum NormalEnum {
     /// First variant
@@ -31,7 +31,10 @@ pub enum NormalEnumWithoutDescriptions {
 /// A complex enum with unit and struct variants
 #[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
 enum ComplexEnum {
+    /// Override documentation on the Normal variant
     Normal(NormalEnum),
+
+    /// Documentation on the Hardcore variant
     Hardcore {
         hard: String,
         core: NormalEnum,
@@ -43,7 +46,7 @@ enum ComplexEnum {
 #[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
 #[serde(untagged)]
 enum UntaggedEnum {
-    /// Used in case the `one` field of tpye [`u32`] is present
+    /// Used in case the `one` field of type [`u32`] is present
     A { one: String },
     /// Used in case the `two` field of type [`NormalEnum`] is present
     B { two: NormalEnum },
@@ -192,7 +195,7 @@ fn normal_enum() {
                         "spec": {
                           "properties": {
                             "foo": {
-                              "description": "A very simple enum with empty variants",
+                              "description": "A very simple enum with unit variants",
                               "enum": [
                                 "C",
                                 "D",
@@ -258,7 +261,7 @@ fn optional_enum() {
                         "spec": {
                           "properties": {
                             "foo": {
-                              "description": "A very simple enum with empty variants",
+                              "description": "A very simple enum with unit variants",
                               "enum": [
                                 "C",
                                 "D",
@@ -482,7 +485,7 @@ fn untagged_enum() {
                                   "type": "string"
                                 },
                                 "two": {
-                                  "description": "A very simple enum with empty variants",
+                                  "description": "A very simple enum with unit variants",
                                   "enum": [
                                     "C",
                                     "D",
@@ -571,7 +574,7 @@ fn optional_untagged_enum() {
                                   "type": "string"
                                 },
                                 "two": {
-                                  "description": "A very simple enum with empty variants",
+                                  "description": "A very simple enum with unit variants",
                                   "enum": [
                                     "C",
                                     "D",
@@ -656,7 +659,7 @@ fn flattened_untagged_enum() {
                                   "type": "string"
                                 },
                                 "two": {
-                                  "description": "A very simple enum with empty variants",
+                                  "description": "A very simple enum with unit variants",
                                   "enum": [
                                     "C",
                                     "D",