Merge branch 'main' into normalizerdoc

hsivonen · Dec 18, 2024 · f355273 · f355273
2 parents 59d9ba1 + b7d2a25
commit f355273
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/ffi/capi/bindings/dart/DataProvider.g.dart b/ffi/capi/bindings/dart/DataProvider.g.dart
diff --git a/ffi/capi/bindings/js/DataProvider.d.ts b/ffi/capi/bindings/js/DataProvider.d.ts
diff --git a/ffi/capi/bindings/js/DataProvider.mjs b/ffi/capi/bindings/js/DataProvider.mjs
diff --git a/ffi/capi/src/provider.rs b/ffi/capi/src/provider.rs
@@ -23,6 +23,11 @@ pub mod ffi {
 
     #[diplomat::opaque]
     /// An ICU4X data provider, capable of loading ICU4X data keys from some source.
+    ///
+    /// Currently the only source supported is loading from "blob" formatted data from a bytes buffer or the file system.
+    ///
+    /// If you wish to use ICU4X's builtin "compiled data", use the version of the constructors that do not have `_with_provider`
+    /// in their names.
     #[diplomat::rust_link(icu_provider, Mod)]
     pub struct DataProvider(pub DataProviderInner);