Skip to content

Commit 3ac6795

Browse files
authored
Update features.md
1 parent 5828a4f commit 3ac6795

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/doc/src/reference/features.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -514,8 +514,8 @@ source and inspect it.
514514
[`cargo vendor`]: ../commands/cargo-vendor.md
515515
[cargo-clone-crate]: https://crates.io/crates/cargo-clone-crate
516516

517-
### Caveats
517+
### Feature combinations
518518

519-
Features, which are a form of conditional compilation, require an exponential number of configurations and test cases to be 100% covered. By default, testing, linting, Miri, docs and others will only run on the default set of features.
519+
Because features are a form of conditional compilation, they require an exponential number of configurations and test cases to be 100% covered. By default, tests, docs, and other tooling such as [Clippy](https://github.com/rust-lang/rust-clippy) will only run with the default set of features.
520520

521-
There are certain tools like [cargo-hack](https://github.com/taiki-e/cargo-hack) and [cargo-all-features](https://github.com/frewsxcv/cargo-all-features) that allow you to test all combinations of features which can help reduce the amount of configuraton needed.
521+
We encourage you to consider your strategy and tooling in regards to different feature combinations - Every project will have different requirements in conjunction with time, resources, and the cost-benefit of covering specific scenarios. Common configurations may be with / without default features, specific combinations of features, or all combinations of features.

0 commit comments

Comments
 (0)