better docs

smithy-lang · Jul 6, 2023 · 7d80faf · 7d80faf
1 parent 8d78bd4
commit 7d80faf
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil/Rust.kt b/codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil/Rust.kt
@@ -381,6 +381,15 @@ fun FileManifest.printGeneratedFiles() {
  * Setting `runClippy` to true can be helpful when debugging clippy failures, but
  * should generally be set to `false` to avoid invalidating the Cargo cache between
  * every unit test run.
+ * If you want to enable each features individually, specify the name of the feature on featuresToEnable.
+ * e.g.
+ * ```kotlin
+ * compileAndTest(featuresToEnable = ["this", "that"])
+ * ```
+ * All features are enabled by default. If you wish to disable them, set enableAllFeatures to False.
+ * ```kotlin
+ * compileAndTest(featuresToEnable = false)
+ * ```
  */
 fun TestWriterDelegator.compileAndTest(
     runClippy: Boolean = false,