Make ScriptDisplayNames be public (#3317)

unicode-org · Apr 13, 2023 · 01039ce · 01039ce
1 parent 1489105
commit 01039ce
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 19 deletions.
diff --git a/experimental/displaynames/src/displaynames.rs b/experimental/displaynames/src/displaynames.rs
@@ -84,25 +84,25 @@ impl RegionDisplayNames {
     }
 }
 
-// / Lookup of the locale-specific display names by script code.
-// /
-// / # Example
-// /
-// / ```
-// / use icu_displaynames::{DisplayNamesOptios, ScriptDisplayNames};
-// / use icu_locid::{locale, subtags_script as script};
-// /
-// / let locale = locale!("en-001");
-// / let options: DisplayNamesOptions = Default::default();
-// / let display_name = ScriptDisplayNames::try_new_unstable(
-// /     &icu_testdata::unstable(),
-// /     &locale.into(),
-// /     options,
-// / )
-// / .expect("Data should load successfully");
-// /
-// / assert_eq!(display_name.of(script!("Hant")), Some("United Arab Emirates"));
-// / ```
+/// Lookup of the locale-specific display names by script code.
+///
+/// # Example
+///
+/// ```
+/// use icu_displaynames::{DisplayNamesOptions, ScriptDisplayNames};
+/// use icu_locid::{locale, subtags_script as script};
+///
+/// let locale = locale!("en-001");
+/// let options: DisplayNamesOptions = Default::default();
+/// let display_name = ScriptDisplayNames::try_new_unstable(
+///     &icu_testdata::unstable(),
+///     &locale.into(),
+///     options,
+/// )
+/// .expect("Data should load successfully");
+///
+/// assert_eq!(display_name.of(script!("Maya")), Some("Mayan hieroglyphs"));
+/// ```
 #[derive(Default)]
 pub struct ScriptDisplayNames {
     options: DisplayNamesOptions,

diff --git a/experimental/displaynames/src/lib.rs b/experimental/displaynames/src/lib.rs
@@ -42,6 +42,7 @@ pub mod provider;
 pub use displaynames::LanguageDisplayNames;
 pub use displaynames::LocaleDisplayNamesFormatter;
 pub use displaynames::RegionDisplayNames;
+pub use displaynames::ScriptDisplayNames;
 pub use options::DisplayNamesOptions;
 pub use options::Fallback;
 pub use options::LanguageDisplay;

diff --git a/provider/datagen/src/transform/cldr/displaynames/script.rs b/provider/datagen/src/transform/cldr/displaynames/script.rs
@@ -56,6 +56,7 @@ impl IterableDataProvider<ScriptDisplayNamesV1Marker> for crate::DatagenProvider
 }
 
 /// Substring used to denote alternative display names data variants for a given script. For example: "BA-alt-short", "TL-alt-variant".
+/// TODO(#3316): Distinguish stand-alone ("Traditional Han") from default ("Traditional")
 const ALT_SUBSTRING: &str = "-alt-";
 /// Substring used to denote short display names data variants for a given script. For example: "az-alt-short".
 const ALT_SHORT_SUBSTRING: &str = "-alt-short";