Skip to content

Commit b10859a

Browse files
robertbastianrobertbastian
authored
format docs (#2657)
1 parent a64c345 commit b10859a

File tree

110 files changed

+965
-532
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+965
-532
lines changed

‎components/calendar/src/buddhist.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ impl Date<Buddhist> {
160160
/// use icu::calendar::Date;
161161
/// use std::convert::TryFrom;
162162
///
163-
/// let date_buddhist =
164-
/// Date::try_new_buddhist_date(1970, 1, 2).expect("Failed to initialize Buddhist Date instance.");
163+
/// let date_buddhist = Date::try_new_buddhist_date(1970, 1, 2)
164+
/// .expect("Failed to initialize Buddhist Date instance.");
165165
///
166166
/// assert_eq!(date_buddhist.year().number, 1970);
167167
/// assert_eq!(date_buddhist.month().ordinal, 1);
@@ -185,8 +185,9 @@ impl DateTime<Buddhist> {
185185
/// ```rust
186186
/// use icu::calendar::DateTime;
187187
///
188-
/// let datetime_buddhist = DateTime::try_new_buddhist_datetime(1970, 1, 2, 13, 1, 0)
189-
/// .expect("Failed to initialize Buddhist DateTime instance.");
188+
/// let datetime_buddhist =
189+
/// DateTime::try_new_buddhist_datetime(1970, 1, 2, 13, 1, 0)
190+
/// .expect("Failed to initialize Buddhist DateTime instance.");
190191
///
191192
/// assert_eq!(datetime_buddhist.date.year().number, 1970);
192193
/// assert_eq!(datetime_buddhist.date.month().ordinal, 1);

‎components/calendar/src/coptic.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ impl Date<Coptic> {
244244
/// ```rust
245245
/// use icu::calendar::Date;
246246
///
247-
/// let date_coptic =
248-
/// Date::try_new_coptic_date(1686, 5, 6).expect("Failed to initialize Coptic Date instance.");
247+
/// let date_coptic = Date::try_new_coptic_date(1686, 5, 6)
248+
/// .expect("Failed to initialize Coptic Date instance.");
249249
///
250250
/// assert_eq!(date_coptic.year().number, 1686);
251251
/// assert_eq!(date_coptic.month().ordinal, 5);
@@ -280,8 +280,9 @@ impl DateTime<Coptic> {
280280
/// ```rust
281281
/// use icu::calendar::DateTime;
282282
///
283-
/// let datetime_coptic = DateTime::try_new_coptic_datetime(1686, 5, 6, 13, 1, 0)
284-
/// .expect("Failed to initialize Coptic DateTime instance.");
283+
/// let datetime_coptic =
284+
/// DateTime::try_new_coptic_datetime(1686, 5, 6, 13, 1, 0)
285+
/// .expect("Failed to initialize Coptic DateTime instance.");
285286
///
286287
/// assert_eq!(datetime_coptic.date.year().number, 1686);
287288
/// assert_eq!(datetime_coptic.date.month().ordinal, 5);

‎components/calendar/src/date.rs

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -237,19 +237,16 @@ impl<A: AsCalendar> Date<A> {
237237
/// # Examples
238238
///
239239
/// ```
240-
/// use icu::calendar::Date;
241-
/// use icu::calendar::types::WeekOfMonth;
242240
/// use icu::calendar::types::IsoWeekday;
241+
/// use icu::calendar::types::WeekOfMonth;
242+
/// use icu::calendar::Date;
243243
///
244244
/// let date = Date::try_new_iso_date(2022, 8, 10).unwrap(); // second Wednesday
245245
///
246246
/// // The following info is usually locale-specific
247247
/// let first_weekday = IsoWeekday::Sunday;
248248
///
249-
/// assert_eq!(
250-
/// date.week_of_month(first_weekday),
251-
/// WeekOfMonth(2)
252-
/// );
249+
/// assert_eq!(date.week_of_month(first_weekday), WeekOfMonth(2));
253250
/// ```
254251
pub fn week_of_month(&self, first_weekday: types::IsoWeekday) -> types::WeekOfMonth {
255252
let config = WeekCalculator {
@@ -264,11 +261,11 @@ impl<A: AsCalendar> Date<A> {
264261
/// # Examples
265262
///
266263
/// ```
267-
/// use icu::calendar::Date;
268264
/// use icu::calendar::types::IsoWeekday;
269-
/// use icu::calendar::week::WeekCalculator;
270265
/// use icu::calendar::week::RelativeUnit;
266+
/// use icu::calendar::week::WeekCalculator;
271267
/// use icu::calendar::week::WeekOf;
268+
/// use icu::calendar::Date;
272269
///
273270
/// let date = Date::try_new_iso_date(2022, 8, 26).unwrap();
274271
///

‎components/calendar/src/duration.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ use core::marker::PhantomData;
1313
/// # Example
1414
///
1515
/// ```rust
16-
/// use icu_calendar::{types::IsoWeekday, Date, DateDuration, DateDurationUnit};
16+
/// use icu_calendar::{
17+
/// types::IsoWeekday, Date, DateDuration, DateDurationUnit,
18+
/// };
1719
///
1820
/// // Creating ISO date: 1992-09-02.
1921
/// let mut date_iso = Date::try_new_iso_date(1992, 9, 2)
@@ -45,7 +47,11 @@ use core::marker::PhantomData;
4547
/// .expect("Failed to initialize ISO Date instance.");
4648
///
4749
/// // Comparing dates: 2022-01-30 and 1992-09-02.
48-
/// let duration = newer_date_iso.until(&date_iso, DateDurationUnit::Years, DateDurationUnit::Days);
50+
/// let duration = newer_date_iso.until(
51+
/// &date_iso,
52+
/// DateDurationUnit::Years,
53+
/// DateDurationUnit::Days,
54+
/// );
4955
/// assert_eq!(duration.years, 30);
5056
/// assert_eq!(duration.months, -8);
5157
/// assert_eq!(duration.days, 28);

‎components/calendar/src/ethiopian.rs

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
//! // `DateTime` type
1616
//! let datetime_iso = DateTime::try_new_iso_datetime(1970, 1, 2, 13, 1, 0)
1717
//! .expect("Failed to initialize ISO DateTime instance.");
18-
//! let datetime_ethiopian = DateTime::new_from_iso(datetime_iso, Ethiopian::new());
18+
//! let datetime_ethiopian =
19+
//! DateTime::new_from_iso(datetime_iso, Ethiopian::new());
1920
//!
2021
//! // `Date` checks
2122
//! assert_eq!(date_ethiopian.year().number, 1962);
@@ -308,12 +309,16 @@ impl Date<Ethiopian> {
308309
/// and so on.
309310
///
310311
/// ```rust
311-
/// use icu::calendar::Date;
312312
/// use icu::calendar::ethiopian::EthiopianEraStyle;
313+
/// use icu::calendar::Date;
313314
///
314-
/// let date_ethiopian =
315-
/// Date::try_new_ethiopian_date(EthiopianEraStyle::AmeteMihret, 2014, 8, 25)
316-
/// .expect("Failed to initialize Ethopic Date instance.");
315+
/// let date_ethiopian = Date::try_new_ethiopian_date(
316+
/// EthiopianEraStyle::AmeteMihret,
317+
/// 2014,
318+
/// 8,
319+
/// 25,
320+
/// )
321+
/// .expect("Failed to initialize Ethopic Date instance.");
317322
///
318323
/// assert_eq!(date_ethiopian.year().number, 2014);
319324
/// assert_eq!(date_ethiopian.month().ordinal, 8);
@@ -355,11 +360,19 @@ impl DateTime<Ethiopian> {
355360
/// and so on.
356361
///
357362
/// ```rust
358-
/// use icu::calendar::DateTime;
359363
/// use icu::calendar::ethiopian::EthiopianEraStyle;
364+
/// use icu::calendar::DateTime;
360365
///
361-
/// let datetime_ethiopian = DateTime::try_new_ethiopian_datetime(EthiopianEraStyle::AmeteMihret, 2014, 8, 25, 13, 1, 0)
362-
/// .expect("Failed to initialize Ethiopian DateTime instance.");
366+
/// let datetime_ethiopian = DateTime::try_new_ethiopian_datetime(
367+
/// EthiopianEraStyle::AmeteMihret,
368+
/// 2014,
369+
/// 8,
370+
/// 25,
371+
/// 13,
372+
/// 1,
373+
/// 0,
374+
/// )
375+
/// .expect("Failed to initialize Ethiopian DateTime instance.");
363376
///
364377
/// assert_eq!(datetime_ethiopian.date.year().number, 2014);
365378
/// assert_eq!(datetime_ethiopian.date.month().ordinal, 8);

‎components/calendar/src/gregorian.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ impl Date<Gregorian> {
164164
/// Years are specified as ISO years.
165165
///
166166
/// ```rust
167-
/// use icu::calendar::{Date};
167+
/// use icu::calendar::Date;
168168
/// use std::convert::TryFrom;
169169
///
170170
/// // Conversion from ISO to Gregorian
@@ -192,8 +192,9 @@ impl DateTime<Gregorian> {
192192
/// ```rust
193193
/// use icu::calendar::DateTime;
194194
///
195-
/// let datetime_gregorian = DateTime::try_new_gregorian_datetime(1970, 1, 2, 13, 1, 0)
196-
/// .expect("Failed to initialize Gregorian DateTime instance.");
195+
/// let datetime_gregorian =
196+
/// DateTime::try_new_gregorian_datetime(1970, 1, 2, 13, 1, 0)
197+
/// .expect("Failed to initialize Gregorian DateTime instance.");
197198
///
198199
/// assert_eq!(datetime_gregorian.date.year().number, 1970);
199200
/// assert_eq!(datetime_gregorian.date.month().ordinal, 1);

‎components/calendar/src/indian.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,8 @@ impl Date<Indian> {
246246
/// ```rust
247247
/// use icu::calendar::Date;
248248
///
249-
/// let date_indian =
250-
/// Date::try_new_indian_date(1891, 10, 12).expect("Failed to initialize Indian Date instance.");
249+
/// let date_indian = Date::try_new_indian_date(1891, 10, 12)
250+
/// .expect("Failed to initialize Indian Date instance.");
251251
///
252252
/// assert_eq!(date_indian.year().number, 1891);
253253
/// assert_eq!(date_indian.month().ordinal, 10);
@@ -280,8 +280,9 @@ impl DateTime<Indian> {
280280
/// ```rust
281281
/// use icu::calendar::DateTime;
282282
///
283-
/// let datetime_indian = DateTime::try_new_indian_datetime(1891, 10, 12, 13, 1, 0)
284-
/// .expect("Failed to initialize Indian DateTime instance.");
283+
/// let datetime_indian =
284+
/// DateTime::try_new_indian_datetime(1891, 10, 12, 13, 1, 0)
285+
/// .expect("Failed to initialize Indian DateTime instance.");
285286
///
286287
/// assert_eq!(datetime_indian.date.year().number, 1891);
287288
/// assert_eq!(datetime_indian.date.month().ordinal, 10);

‎components/calendar/src/iso.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,10 @@ impl DateTime<Iso> {
286286
/// let today = DateTime::try_new_iso_datetime(2020, 2, 29, 0, 0, 0).unwrap();
287287
///
288288
/// assert_eq!(today.minutes_since_local_unix_epoch(), 26382240);
289-
/// assert_eq!(DateTime::from_minutes_since_local_unix_epoch(26382240), today);
289+
/// assert_eq!(
290+
/// DateTime::from_minutes_since_local_unix_epoch(26382240),
291+
/// today
292+
/// );
290293
///
291294
/// let today = DateTime::try_new_iso_datetime(1970, 1, 1, 0, 0, 0).unwrap();
292295
///
@@ -316,7 +319,10 @@ impl DateTime<Iso> {
316319
/// let today = DateTime::try_new_iso_datetime(2020, 2, 29, 0, 0, 0).unwrap();
317320
///
318321
/// assert_eq!(today.minutes_since_local_unix_epoch(), 26382240);
319-
/// assert_eq!(DateTime::from_minutes_since_local_unix_epoch(26382240), today);
322+
/// assert_eq!(
323+
/// DateTime::from_minutes_since_local_unix_epoch(26382240),
324+
/// today
325+
/// );
320326
///
321327
/// let today = DateTime::try_new_iso_datetime(1970, 1, 1, 0, 0, 0).unwrap();
322328
///

‎components/calendar/src/japanese.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,8 @@ impl Date<Japanese> {
405405
///
406406
/// // This function will error for eras that are out of bounds:
407407
/// // (Heisei was 32 years long, Heisei 33 is in Reiwa)
408-
/// let oob_date = Date::try_new_japanese_date(era, 33, 1, 2, japanese_calendar);
408+
/// let oob_date =
409+
/// Date::try_new_japanese_date(era, 33, 1, 2, japanese_calendar);
409410
/// assert!(oob_date.is_err());
410411
///
411412
/// // and for unknown eras

‎components/calendar/src/julian.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,8 @@ impl Date<Julian> {
276276
/// ```rust
277277
/// use icu::calendar::Date;
278278
///
279-
/// let date_julian =
280-
/// Date::try_new_julian_date(1969, 12, 20).expect("Failed to initialize Julian Date instance.");
279+
/// let date_julian = Date::try_new_julian_date(1969, 12, 20)
280+
/// .expect("Failed to initialize Julian Date instance.");
281281
///
282282
/// assert_eq!(date_julian.year().number, 1969);
283283
/// assert_eq!(date_julian.month().ordinal, 12);
@@ -314,8 +314,9 @@ impl DateTime<Julian> {
314314
/// ```rust
315315
/// use icu::calendar::DateTime;
316316
///
317-
/// let datetime_julian = DateTime::try_new_julian_datetime(1969, 12, 20, 13, 1, 0)
318-
/// .expect("Failed to initialize Julian DateTime instance.");
317+
/// let datetime_julian =
318+
/// DateTime::try_new_julian_datetime(1969, 12, 20, 13, 1, 0)
319+
/// .expect("Failed to initialize Julian DateTime instance.");
319320
///
320321
/// assert_eq!(datetime_julian.date.year().number, 1969);
321322
/// assert_eq!(datetime_julian.date.month().ordinal, 12);

0 commit comments

Comments
 (0)