Skip to content

Commit

Permalink
Remove duplicate feature notes from docs (#5794)
Browse files Browse the repository at this point in the history
  • Loading branch information
@robertbastian
robertbastian authored Nov 7, 2024
1 parent b6e388a commit 01c88b8
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 78 deletions.
4 changes: 0 additions & 4 deletions components/calendar/src/week_of.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ impl WeekCalculator {
icu_provider::gen_any_buffer_data_constructors!(
(locale) -> error: DataError,
/// Creates a new [`WeekCalculator`] from compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
);

#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
Expand Down
18 changes: 9 additions & 9 deletions components/datetime/src/options/components.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
//!
//! <div class="stab unstable">
//! 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
//! including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
//! including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
//! of the icu meta-crate. Use with caution.
//! <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
//! </div>
Expand Down Expand Up @@ -98,7 +98,7 @@ use serde::{Deserialize, Serialize};
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down Expand Up @@ -402,7 +402,7 @@ impl Bag {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand All @@ -424,7 +424,7 @@ pub enum Numeric {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand All @@ -451,7 +451,7 @@ pub enum Text {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down Expand Up @@ -479,7 +479,7 @@ pub enum Year {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down Expand Up @@ -512,7 +512,7 @@ pub enum Month {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand All @@ -536,7 +536,7 @@ pub enum Week {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down Expand Up @@ -565,7 +565,7 @@ pub enum Day {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down
2 changes: 1 addition & 1 deletion components/datetime/src/options/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ pub enum DateTimeFormatterOptions {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down
6 changes: 3 additions & 3 deletions components/datetime/src/options/preferences.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
//!
//! <div class="stab unstable">
//! 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
//! including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
//! including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
//! of the icu meta-crate. Use with caution.
//! <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
//! </div>
Expand Down Expand Up @@ -47,7 +47,7 @@ use icu_locale_core::{
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down Expand Up @@ -84,7 +84,7 @@ impl Bag {
///
/// <div class="stab unstable">
/// 🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways,
/// including in SemVer minor releases. It can be enabled with the "experimental" Cargo feature
/// including in SemVer minor releases. It can be enabled with the `experimental` Cargo feature
/// of the icu meta-crate. Use with caution.
/// <a href="https://github.com/unicode-org/icu4x/issues/1317">#1317</a>
/// </div>
Expand Down
5 changes: 0 additions & 5 deletions components/decimal/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,8 @@ impl AsRef<FixedDecimalFormatter> for FixedDecimalFormatter {

impl FixedDecimalFormatter {
icu_provider::gen_any_buffer_data_constructors!(

(locale, options: options::FixedDecimalFormatterOptions) -> error: DataError,
/// Creates a new [`FixedDecimalFormatter`] from compiled data and an options bag.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
);

#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::try_new)]
Expand Down
20 changes: 0 additions & 20 deletions components/experimental/src/displaynames/displaynames.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,6 @@ impl RegionDisplayNames {
icu_provider::gen_any_buffer_data_constructors!(
(locale, options: DisplayNamesOptions) -> error: DataError,
/// Creates a new [`RegionDisplayNames`] from locale data and an options bag using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new,
try_new_with_any_provider,
Expand Down Expand Up @@ -113,10 +109,6 @@ impl ScriptDisplayNames {
icu_provider::gen_any_buffer_data_constructors!(
(locale, options: DisplayNamesOptions) -> error: DataError,
/// Creates a new [`ScriptDisplayNames`] from locale data and an options bag using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new,
try_new_with_any_provider,
Expand Down Expand Up @@ -185,10 +177,6 @@ impl VariantDisplayNames {
icu_provider::gen_any_buffer_data_constructors!(
(locale, options: DisplayNamesOptions) -> error: DataError,
/// Creates a new [`VariantDisplayNames`] from locale data and an options bag using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new,
try_new_with_any_provider,
Expand Down Expand Up @@ -252,10 +240,6 @@ impl LanguageDisplayNames {
icu_provider::gen_any_buffer_data_constructors!(
(locale, options: DisplayNamesOptions) -> error: DataError,
/// Creates a new [`LanguageDisplayNames`] from locale data and an options bag using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new,
try_new_with_any_provider,
Expand Down Expand Up @@ -340,10 +324,6 @@ impl LocaleDisplayNamesFormatter {
icu_provider::gen_any_buffer_data_constructors!(
(locale, options: DisplayNamesOptions) -> error: DataError,
/// Creates a new [`LocaleDisplayNamesFormatter`] from locale data and an options bag using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new,
try_new_with_any_provider,
Expand Down
4 changes: 0 additions & 4 deletions components/list/src/list_formatter.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ macro_rules! constructor {
///
/// See the [CLDR spec](https://unicode.org/reports/tr35/tr35-general.html#ListPatterns) for
/// an explanation of the different types.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
$name,
$name_any,
Expand Down
28 changes: 0 additions & 28 deletions components/plurals/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -294,10 +294,6 @@ impl PluralRules {
(locale, rule_type: PluralRuleType) -> error: DataError,
/// Constructs a new `PluralRules` for a given locale and type using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -338,10 +334,6 @@ impl PluralRules {
/// * [`One`]: `1 day`
/// * [`Other`]: `0 days`, `2 days`, `10 days`, `0.3 days`
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -393,10 +385,6 @@ impl PluralRules {
/// * [`Few`]: `3rd floor`, `23rd floor`, `103rd floor`
/// * [`Other`]: `4th floor`, `11th floor`, `96th floor`
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -603,10 +591,6 @@ impl PluralRulesWithRanges<PluralRules> {
(locale, rule_type: PluralRuleType) -> error: DataError,
/// Constructs a new `PluralRulesWithRanges` for a given locale using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -642,10 +626,6 @@ impl PluralRulesWithRanges<PluralRules> {
///
/// See [`PluralRules::try_new_cardinal`] for more information.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -683,10 +663,6 @@ impl PluralRulesWithRanges<PluralRules> {
///
/// See [`PluralRules::try_new_ordinal`] for more information.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down Expand Up @@ -735,10 +711,6 @@ where
/// The provided `locale` **MUST** be the same as the locale provided to the constructor
/// of `rules`. Otherwise, [`Self::category_for_range`] will return incorrect results.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
///
/// # Examples
///
/// ```
Expand Down
4 changes: 0 additions & 4 deletions components/segmenter/src/sentence.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,6 @@ impl SentenceSegmenter {
icu_provider::gen_any_buffer_data_constructors!(
(options: SentenceBreakOptions) -> error: DataError,
/// Constructs a [`SentenceSegmenter`] for a given options and using compiled data.
///
/// ✨ *Enabled with the `compiled_data` Cargo feature.*
///
/// [📚 Help choosing a constructor](icu_provider::constructors)
functions: [
try_new_with_options,
try_new_with_options_with_any_provider,
Expand Down

0 comments on commit 01c88b8

Please sign in to comment.