asdf

Author: thomas-k-cameron

codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/SerdeDecorator.kt

@@ -15,9 +15,7 @@ import software.amazon.smithy.rust.codegen.core.smithy.generators.LibRsSection
 import software.amazon.smithy.rust.codegen.core.smithy.generators.ModuleDocSection
 
 /**
- * This class,
- * - Adds serde as a dependency
- *
+ * Decorator that adds the `serde-serialize` and `serde-deserialize` features.
  */
 class SerdeDecorator : ClientCodegenDecorator {
     override val name: String = "SerdeDecorator"
@@ -38,17 +36,31 @@ class SerdeDecorator : ClientCodegenDecorator {
 }
 
 class SerdeDocGenerator(private val codegenContext: ClientCodegenContext) : LibRsCustomization() {
+    companion object {
+        const val SerdeInfoText = """## How to enable `Serialize` and `Deserialize`
+
+            This data type implements `Serialize` and `Deserialize` traits from the popular serde crate,
+            but those traits are behind feature gate.
+
+            As they increase it's compile time dramatically, you should not turn them on unless it's necessary.
+            Furthermore, implementation of serde is still unstable, and implementation may change anytime in future.
+
+            To enable traits, you must pass `aws_sdk_unstable` to RUSTFLAGS and enable `serde-serialize` or `serde-deserialize` feature.
+
+            e.g.
+            ```bash,no_run
+            export RUSTFLAGS="--cfg aws_sdk_unstable"
+            cargo build --features serde-serialize serde-deserialize
+            ```
+
+            If you enable `serde-serialize` and/or `serde-deserialize` without `RUSTFLAGS="--cfg aws_sdk_unstable"`,
+            compilation will fail with warning.
+
+        """
+    }
     override fun section(section: LibRsSection): Writable {
         return if (section is LibRsSection.ModuleDoc && section.subsection is ModuleDocSection.UnstableFeature) {
-            writable {
-                """
-                ## How to enable `Serialize` and `Deserialize`
-                This data type implements `Serialize` and `Deserialize` traits from the popular serde crate,
-                but those traits are behind feature gate.
-
-                As they increase it's compile time dramatically, you should not turn them on unless it's necessary.
-                """.trimIndent()
-            }
+            writable { SerdeInfoText.trimIndent() }
         } else {
             emptySection
         }