Skip to content

Commit 96a26f8

Browse files
authored
Docs: Make explicit that the experimental-module-builds is unstable
CC #9329
1 parent b0b8a0a commit 96a26f8

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

api/rs/build/Cargo.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,13 @@ path = "lib.rs"
1919

2020
[features]
2121
default = []
22-
experimental-module-builds = ["i-slint-compiler/experimental-library-module"]
22+
## Enable the [`CompilerConfiguration::with_sdf_fonts`] function that encodes the font's glyphs as scalable signed distance fields, to reduce the size.
2323
sdf-fonts = ["i-slint-compiler/sdf-fonts"]
24+
## Enable this feature when building `.slint` libraries.
25+
## This feature is experimental and may change or be removed in the future,
26+
## enabling it implies opting out of [semver](https://semver.org).
27+
## For details of this experiment, see: <https://github.com/slint-ui/slint/issues/7060>
28+
experimental-module-builds = ["i-slint-compiler/experimental-library-module"]
2429

2530
[dependencies]
2631
i-slint-compiler = { workspace = true, features = ["default", "rust", "display-diagnostics", "software-renderer", "bundle-translations"] }
@@ -30,5 +35,5 @@ toml_edit = { workspace = true }
3035
derive_more = { workspace = true, features = ["std", "error"] }
3136

3237
[package.metadata.docs.rs]
33-
all-features = true
38+
features = ["sdf-fonts"]
3439
rustdoc-args = ["--generate-link-to-definition"]

api/rs/build/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,8 @@ impl CompilerConfiguration {
209209
///
210210
/// Use this when the components and types of the Slint code need
211211
/// to be accessible from other modules.
212+
///
213+
/// **Note**: This feature is experimental and may change or be removed in the future.
212214
#[cfg(feature = "experimental-module-builds")]
213215
#[must_use]
214216
pub fn as_library(self, library_name: &str) -> Self {
@@ -218,6 +220,8 @@ impl CompilerConfiguration {
218220
}
219221

220222
/// Specify the Rust module to place the generated code in.
223+
///
224+
/// **Note**: This feature is experimental and may change or be removed in the future.
221225
#[cfg(feature = "experimental-module-builds")]
222226
#[must_use]
223227
pub fn rust_module(self, rust_module: &str) -> Self {

0 commit comments

Comments
 (0)