Skip to content

Commit 7d80faf

Browse files
better docs
1 parent 8d78bd4 commit 7d80faf

File tree

1 file changed

+9
-0
lines changed
  • codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil

1 file changed

+9
-0
lines changed

codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/testutil/Rust.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,15 @@ fun FileManifest.printGeneratedFiles() {
381381
* Setting `runClippy` to true can be helpful when debugging clippy failures, but
382382
* should generally be set to `false` to avoid invalidating the Cargo cache between
383383
* every unit test run.
384+
* If you want to enable each features individually, specify the name of the feature on featuresToEnable.
385+
* e.g.
386+
* ```kotlin
387+
* compileAndTest(featuresToEnable = ["this", "that"])
388+
* ```
389+
* All features are enabled by default. If you wish to disable them, set enableAllFeatures to False.
390+
* ```kotlin
391+
* compileAndTest(featuresToEnable = false)
392+
* ```
384393
*/
385394
fun TestWriterDelegator.compileAndTest(
386395
runClippy: Boolean = false,

0 commit comments

Comments
 (0)