Skip to content

Commit 59894b0

Browse files
authored
Format examples (unicode-org#4068)
1 parent e513d96 commit 59894b0

File tree

84 files changed

+676
-656
lines changed

Some content is hidden

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

84 files changed

+676
-656
lines changed

components/calendar/src/chinese.rs

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55
//! This module contains types and implementations for the Chinese calendar.
66
//!
77
//! ```rust
8-
//! use icu::calendar::{Ref, Date, DateTime, chinese::Chinese};
8+
//! use icu::calendar::{chinese::Chinese, Date, DateTime, Ref};
99
//!
1010
//! let chinese = Chinese::new_always_calculating();
1111
//! let chinese = Ref(&chinese); // to avoid cloning
1212
//!
1313
//! // `Date` type
14-
//! let chinese_date = Date::try_new_chinese_date_with_calendar(4660, 6, 6, chinese)
15-
//! .expect("Failed to initialize Chinese Date instance.");
14+
//! let chinese_date =
15+
//! Date::try_new_chinese_date_with_calendar(4660, 6, 6, chinese)
16+
//! .expect("Failed to initialize Chinese Date instance.");
1617
//!
1718
//! // `DateTime` type
18-
//! let chinese_datetime = DateTime::try_new_chinese_datetime_with_calendar(4660, 6, 6, 13, 1, 0, chinese)
19-
//! .expect("Failed to initialize Chinese DateTime instance");
19+
//! let chinese_datetime = DateTime::try_new_chinese_datetime_with_calendar(
20+
//! 4660, 6, 6, 13, 1, 0, chinese,
21+
//! )
22+
//! .expect("Failed to initialize Chinese DateTime instance");
2023
//!
2124
//! // `Date` checks
2225
//! assert_eq!(chinese_date.year().number, 4660);
@@ -330,8 +333,9 @@ impl<A: AsCalendar<Calendar = Chinese>> Date<A> {
330333
///
331334
/// let chinese = Chinese::new_always_calculating();
332335
///
333-
/// let date_chinese = Date::try_new_chinese_date_with_calendar(4660, 6, 11, chinese)
334-
/// .expect("Failed to initialize Chinese Date instance.");
336+
/// let date_chinese =
337+
/// Date::try_new_chinese_date_with_calendar(4660, 6, 11, chinese)
338+
/// .expect("Failed to initialize Chinese Date instance.");
335339
///
336340
/// assert_eq!(date_chinese.year().number, 4660);
337341
/// assert_eq!(date_chinese.year().cyclic.unwrap().get(), 40);
@@ -366,8 +370,10 @@ impl<A: AsCalendar<Calendar = Chinese>> DateTime<A> {
366370
///
367371
/// let chinese = Chinese::new_always_calculating();
368372
///
369-
/// let chinese_datetime = DateTime::try_new_chinese_datetime_with_calendar(4660, 6, 11, 13, 1, 0, chinese)
370-
/// .expect("Failed to initialize Chinese DateTime instance.");
373+
/// let chinese_datetime = DateTime::try_new_chinese_datetime_with_calendar(
374+
/// 4660, 6, 11, 13, 1, 0, chinese,
375+
/// )
376+
/// .expect("Failed to initialize Chinese DateTime instance.");
371377
///
372378
/// assert_eq!(chinese_datetime.date.year().number, 4660);
373379
/// assert_eq!(chinese_datetime.date.year().related_iso, Some(2023));

components/calendar/src/chinese_based.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66
//! as well as in related and derived calendars such as the Korean and Vietnamese lunar calendars.
77
//!
88
//! ```rust
9-
//! use icu::calendar::{chinese::Chinese, Iso, Date};
9+
//! use icu::calendar::{chinese::Chinese, Date, Iso};
1010
//!
1111
//! let iso_date = Date::try_new_iso_date(2023, 6, 23).unwrap();
12-
//! let chinese_date = Date::new_from_iso(iso_date, Chinese::new_always_calculating());
12+
//! let chinese_date =
13+
//! Date::new_from_iso(iso_date, Chinese::new_always_calculating());
1314
//!
1415
//! assert_eq!(chinese_date.year().number, 4660);
1516
//! assert_eq!(chinese_date.year().related_iso, Some(2023));

components/calendar/src/dangi.rs

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
//! This module contains types and implementations for the Korean Dangi calendar.
66
//!
77
//! ```rust
8-
//! use icu::calendar::{Ref, Date, DateTime};
98
//! use icu::calendar::dangi::Dangi;
9+
//! use icu::calendar::{Date, DateTime, Ref};
1010
//!
1111
//! let dangi = Dangi::new_always_calculating();
1212
//! let dangi = Ref(&dangi); // to avoid cloning
@@ -16,8 +16,10 @@
1616
//! .expect("Failed to initialize Dangi Date instance.");
1717
//!
1818
//! // `DateTime` type
19-
//! let dangi_datetime = DateTime::try_new_dangi_datetime_with_calendar(4356, 6, 6, 13, 1, 0, dangi)
20-
//! .expect("Failed to initialize Dangi DateTime instance.");
19+
//! let dangi_datetime = DateTime::try_new_dangi_datetime_with_calendar(
20+
//! 4356, 6, 6, 13, 1, 0, dangi,
21+
//! )
22+
//! .expect("Failed to initialize Dangi DateTime instance.");
2123
//!
2224
//! // `Date` checks
2325
//! assert_eq!(dangi_date.year().number, 4356);
@@ -64,7 +66,7 @@ use tinystr::tinystr;
6466
/// going to be perfect.
6567
///
6668
/// ```rust
67-
/// use icu::calendar::{Date, dangi::Dangi, chinese::Chinese};
69+
/// use icu::calendar::{chinese::Chinese, dangi::Dangi, Date};
6870
/// use tinystr::tinystr;
6971
///
7072
/// let iso_a = Date::try_new_iso_date(2012, 4, 23).unwrap();
@@ -300,8 +302,8 @@ impl<A: AsCalendar<Calendar = Dangi>> Date<A> {
300302
/// one that loads such data from a provider will be added in the future (#3933)
301303
///
302304
/// ```rust
303-
/// use icu::calendar::Date;
304305
/// use icu::calendar::dangi::Dangi;
306+
/// use icu::calendar::Date;
305307
///
306308
/// let dangi = Dangi::new_always_calculating();
307309
///
@@ -336,13 +338,15 @@ impl<A: AsCalendar<Calendar = Dangi>> DateTime<A> {
336338
/// one that loads such data from a provider will be added in the future (#3933)
337339
///
338340
/// ```rust
339-
/// use icu::calendar::DateTime;
340341
/// use icu::calendar::dangi::Dangi;
342+
/// use icu::calendar::DateTime;
341343
///
342344
/// let dangi = Dangi::new_always_calculating();
343345
///
344-
/// let dangi_datetime = DateTime::try_new_dangi_datetime_with_calendar(4356, 6, 6, 13, 1, 0, dangi)
345-
/// .expect("Failed to initialize Dangi DateTime instance.");
346+
/// let dangi_datetime = DateTime::try_new_dangi_datetime_with_calendar(
347+
/// 4356, 6, 6, 13, 1, 0, dangi,
348+
/// )
349+
/// .expect("Failed to initialize Dangi DateTime instance.");
346350
///
347351
/// assert_eq!(dangi_datetime.date.year().number, 4356);
348352
/// assert_eq!(dangi_datetime.date.year().related_iso, Some(2023));

components/calendar/src/hebrew.rs

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@
55
//! This module contains types and implementations for the Hebrew calendar.
66
//!
77
//! ```rust
8-
//! use icu::calendar::{Ref, Date, DateTime, hebrew::Hebrew};
8+
//! use icu::calendar::{hebrew::Hebrew, Date, DateTime, Ref};
99
//!
1010
//! let hebrew = Hebrew::new_always_calculating();
1111
//! let hebrew = Ref(&hebrew); // to avoid cloning
1212
//!
1313
//! // `Date` type
14-
//! let hebrew_date = Date::try_new_hebrew_date_with_calendar(3425, 10, 11, hebrew)
15-
//! .expect("Failed to initialize hebrew Date instance.");
14+
//! let hebrew_date =
15+
//! Date::try_new_hebrew_date_with_calendar(3425, 10, 11, hebrew)
16+
//! .expect("Failed to initialize hebrew Date instance.");
1617
//!
1718
//! // `DateTime` type
18-
//! let hebrew_datetime = DateTime::try_new_hebrew_datetime_with_calendar(3425, 10, 11, 13, 1, 0, hebrew)
19-
//! .expect("Failed to initialize hebrew DateTime instance.");
19+
//! let hebrew_datetime = DateTime::try_new_hebrew_datetime_with_calendar(
20+
//! 3425, 10, 11, 13, 1, 0, hebrew,
21+
//! )
22+
//! .expect("Failed to initialize hebrew DateTime instance.");
2023
//!
2124
//! // `Date` checks
2225
//! assert_eq!(hebrew_date.year().number, 3425);
@@ -347,13 +350,14 @@ impl<A: AsCalendar<Calendar = Hebrew>> Date<A> {
347350
///
348351
///
349352
/// ```rust
350-
/// use icu::calendar::Date;
351353
/// use icu::calendar::hebrew::Hebrew;
354+
/// use icu::calendar::Date;
352355
///
353356
/// let hebrew = Hebrew::new_always_calculating();
354357
///
355-
/// let date_hebrew = Date::try_new_hebrew_date_with_calendar(3425, 4, 25, hebrew)
356-
/// .expect("Failed to initialize Hebrew Date instance.");
358+
/// let date_hebrew =
359+
/// Date::try_new_hebrew_date_with_calendar(3425, 4, 25, hebrew)
360+
/// .expect("Failed to initialize Hebrew Date instance.");
357361
///
358362
/// assert_eq!(date_hebrew.year().number, 3425);
359363
/// assert_eq!(date_hebrew.month().ordinal, 4);
@@ -378,13 +382,15 @@ impl<A: AsCalendar<Calendar = Hebrew>> DateTime<A> {
378382
/// one that loads such data from a provider will be added in the future (#3933)
379383
///
380384
/// ```rust
381-
/// use icu::calendar::DateTime;
382385
/// use icu::calendar::hebrew::Hebrew;
386+
/// use icu::calendar::DateTime;
383387
///
384388
/// let hebrew = Hebrew::new_always_calculating();
385389
///
386-
/// let datetime_hebrew = DateTime::try_new_hebrew_datetime_with_calendar(4201, 10, 11, 13, 1, 0, hebrew)
387-
/// .expect("Failed to initialize Hebrew DateTime instance");
390+
/// let datetime_hebrew = DateTime::try_new_hebrew_datetime_with_calendar(
391+
/// 4201, 10, 11, 13, 1, 0, hebrew,
392+
/// )
393+
/// .expect("Failed to initialize Hebrew DateTime instance");
388394
///
389395
/// assert_eq!(datetime_hebrew.date.year().number, 4201);
390396
/// assert_eq!(datetime_hebrew.date.month().ordinal, 10);

components/calendar/src/islamic.rs

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,22 @@
55
//! This module contains types and implementations for the Islamic calendars.
66
//!
77
//! ```rust
8-
//! use icu::calendar::{Date, DateTime, Ref};
98
//! use icu::calendar::islamic::IslamicObservational;
9+
//! use icu::calendar::{Date, DateTime, Ref};
1010
//!
1111
//! let islamic = IslamicObservational::new_always_calculating();
1212
//! let islamic = Ref(&islamic); // to avoid cloning
1313
//!
1414
//! // `Date` type
15-
//! let islamic_date = Date::try_new_observational_islamic_date(1348, 10, 11, islamic)
16-
//! .expect("Failed to initialize islamic Date instance.");
15+
//! let islamic_date =
16+
//! Date::try_new_observational_islamic_date(1348, 10, 11, islamic)
17+
//! .expect("Failed to initialize islamic Date instance.");
1718
//!
1819
//! // `DateTime` type
19-
//! let islamic_datetime = DateTime::try_new_observational_islamic_datetime(1348, 10, 11, 13, 1, 0, islamic)
20-
//! .expect("Failed to initialize islamic DateTime instance.");
20+
//! let islamic_datetime = DateTime::try_new_observational_islamic_datetime(
21+
//! 1348, 10, 11, 13, 1, 0, islamic,
22+
//! )
23+
//! .expect("Failed to initialize islamic DateTime instance.");
2124
//!
2225
//! // `Date` checks
2326
//! assert_eq!(islamic_date.year().number, 1348);
@@ -302,13 +305,14 @@ impl<A: AsCalendar<Calendar = IslamicObservational>> Date<A> {
302305
/// Has no negative years, only era is the AH.
303306
///
304307
/// ```rust
305-
/// use icu::calendar::Date;
306308
/// use icu::calendar::islamic::IslamicObservational;
309+
/// use icu::calendar::Date;
307310
///
308311
/// let islamic = IslamicObservational::new_always_calculating();
309312
///
310-
/// let date_islamic = Date::try_new_observational_islamic_date(1392, 4, 25, islamic)
311-
/// .expect("Failed to initialize Islamic Date instance.");
313+
/// let date_islamic =
314+
/// Date::try_new_observational_islamic_date(1392, 4, 25, islamic)
315+
/// .expect("Failed to initialize Islamic Date instance.");
312316
///
313317
/// assert_eq!(date_islamic.year().number, 1392);
314318
/// assert_eq!(date_islamic.month().ordinal, 4);
@@ -330,13 +334,15 @@ impl<A: AsCalendar<Calendar = IslamicObservational>> DateTime<A> {
330334
/// Construct a new Islamic Observational datetime from integers.
331335
///
332336
/// ```rust
333-
/// use icu::calendar::DateTime;
334337
/// use icu::calendar::islamic::IslamicObservational;
338+
/// use icu::calendar::DateTime;
335339
///
336340
/// let islamic = IslamicObservational::new_always_calculating();
337341
///
338-
/// let datetime_islamic = DateTime::try_new_observational_islamic_datetime(474, 10, 11, 13, 1, 0, islamic)
339-
/// .expect("Failed to initialize Islamic DateTime instance.");
342+
/// let datetime_islamic = DateTime::try_new_observational_islamic_datetime(
343+
/// 474, 10, 11, 13, 1, 0, islamic,
344+
/// )
345+
/// .expect("Failed to initialize Islamic DateTime instance.");
340346
///
341347
/// assert_eq!(datetime_islamic.date.year().number, 474);
342348
/// assert_eq!(datetime_islamic.date.month().ordinal, 10);
@@ -489,8 +495,8 @@ impl<A: AsCalendar<Calendar = IslamicUmmAlQura>> Date<A> {
489495
/// Has no negative years, only era is the AH.
490496
///
491497
/// ```rust
492-
/// use icu::calendar::Date;
493498
/// use icu::calendar::islamic::IslamicUmmAlQura;
499+
/// use icu::calendar::Date;
494500
///
495501
/// let islamic = IslamicUmmAlQura::new_always_calculating();
496502
///
@@ -517,13 +523,14 @@ impl<A: AsCalendar<Calendar = IslamicUmmAlQura>> DateTime<A> {
517523
/// Construct a new Islamic Umm al-Qura datetime from integers.
518524
///
519525
/// ```rust
520-
/// use icu::calendar::DateTime;
521526
/// use icu::calendar::islamic::IslamicUmmAlQura;
527+
/// use icu::calendar::DateTime;
522528
///
523529
/// let islamic = IslamicUmmAlQura::new_always_calculating();
524530
///
525-
/// let datetime_islamic = DateTime::try_new_ummalqura_datetime(474, 10, 11, 13, 1, 0, islamic)
526-
/// .expect("Failed to initialize Islamic DateTime instance.");
531+
/// let datetime_islamic =
532+
/// DateTime::try_new_ummalqura_datetime(474, 10, 11, 13, 1, 0, islamic)
533+
/// .expect("Failed to initialize Islamic DateTime instance.");
527534
///
528535
/// assert_eq!(datetime_islamic.date.year().number, 474);
529536
/// assert_eq!(datetime_islamic.date.month().ordinal, 10);
@@ -762,13 +769,14 @@ impl<A: AsCalendar<Calendar = IslamicCivil>> Date<A> {
762769
/// Has no negative years, only era is the AH.
763770
///
764771
/// ```rust
765-
/// use icu::calendar::Date;
766772
/// use icu::calendar::islamic::IslamicCivil;
773+
/// use icu::calendar::Date;
767774
///
768775
/// let islamic = IslamicCivil::new_always_calculating();
769776
///
770-
/// let date_islamic = Date::try_new_islamic_civil_date_with_calendar(1392, 4, 25, islamic)
771-
/// .expect("Failed to initialize Islamic Date instance.");
777+
/// let date_islamic =
778+
/// Date::try_new_islamic_civil_date_with_calendar(1392, 4, 25, islamic)
779+
/// .expect("Failed to initialize Islamic Date instance.");
772780
///
773781
/// assert_eq!(date_islamic.year().number, 1392);
774782
/// assert_eq!(date_islamic.month().ordinal, 4);
@@ -790,12 +798,15 @@ impl<A: AsCalendar<Calendar = IslamicCivil>> DateTime<A> {
790798
/// Construct a new Civil Islamic datetime from integers.
791799
///
792800
/// ```rust
793-
/// use icu::calendar::DateTime;
794801
/// use icu::calendar::islamic::IslamicCivil;
802+
/// use icu::calendar::DateTime;
795803
///
796804
/// let islamic = IslamicCivil::new_always_calculating();
797805
///
798-
/// let datetime_islamic = DateTime::try_new_islamic_civil_datetime_with_calendar(474, 10, 11, 13, 1, 0, islamic)
806+
/// let datetime_islamic =
807+
/// DateTime::try_new_islamic_civil_datetime_with_calendar(
808+
/// 474, 10, 11, 13, 1, 0, islamic,
809+
/// )
799810
/// .expect("Failed to initialize Islamic DateTime instance.");
800811
///
801812
/// assert_eq!(datetime_islamic.date.year().number, 474);
@@ -998,13 +1009,14 @@ impl<A: AsCalendar<Calendar = IslamicTabular>> Date<A> {
9981009
/// Has no negative years, only era is the AH.
9991010
///
10001011
/// ```rust
1001-
/// use icu::calendar::Date;
10021012
/// use icu::calendar::islamic::IslamicTabular;
1013+
/// use icu::calendar::Date;
10031014
///
10041015
/// let islamic = IslamicTabular::new_always_calculating();
10051016
///
1006-
/// let date_islamic = Date::try_new_islamic_tabular_date_with_calendar(1392, 4, 25, islamic)
1007-
/// .expect("Failed to initialize Islamic Date instance.");
1017+
/// let date_islamic =
1018+
/// Date::try_new_islamic_tabular_date_with_calendar(1392, 4, 25, islamic)
1019+
/// .expect("Failed to initialize Islamic Date instance.");
10081020
///
10091021
/// assert_eq!(date_islamic.year().number, 1392);
10101022
/// assert_eq!(date_islamic.month().ordinal, 4);
@@ -1026,12 +1038,15 @@ impl<A: AsCalendar<Calendar = IslamicTabular>> DateTime<A> {
10261038
/// Construct a new Tabular Islamic datetime from integers.
10271039
///
10281040
/// ```rust
1029-
/// use icu::calendar::DateTime;
10301041
/// use icu::calendar::islamic::IslamicTabular;
1042+
/// use icu::calendar::DateTime;
10311043
///
10321044
/// let islamic = IslamicTabular::new_always_calculating();
10331045
///
1034-
/// let datetime_islamic = DateTime::try_new_islamic_tabular_datetime_with_calendar(474, 10, 11, 13, 1, 0, islamic)
1046+
/// let datetime_islamic =
1047+
/// DateTime::try_new_islamic_tabular_datetime_with_calendar(
1048+
/// 474, 10, 11, 13, 1, 0, islamic,
1049+
/// )
10351050
/// .expect("Failed to initialize Islamic DateTime instance.");
10361051
///
10371052
/// assert_eq!(datetime_islamic.date.year().number, 474);

components/calendar/src/persian.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
//! .expect("Failed to initialize Persian Date instance.");
1313
//!
1414
//! // `DateTime` type
15-
//! let persian_datetime = DateTime::try_new_persian_datetime(1348, 10, 11, 13, 1, 0)
16-
//! .expect("Failed to initialize Persian DateTime instance.");
15+
//! let persian_datetime =
16+
//! DateTime::try_new_persian_datetime(1348, 10, 11, 13, 1, 0)
17+
//! .expect("Failed to initialize Persian DateTime instance.");
1718
//!
1819
//! // `Date` checks
1920
//! assert_eq!(persian_date.year().number, 1348);
@@ -265,8 +266,9 @@ impl DateTime<Persian> {
265266
/// ```rust
266267
/// use icu::calendar::DateTime;
267268
///
268-
/// let datetime_persian = DateTime::try_new_persian_datetime(474, 10, 11, 13, 1, 0)
269-
/// .expect("Failed to initialize Persian DateTime instance.");
269+
/// let datetime_persian =
270+
/// DateTime::try_new_persian_datetime(474, 10, 11, 13, 1, 0)
271+
/// .expect("Failed to initialize Persian DateTime instance.");
270272
///
271273
/// assert_eq!(datetime_persian.date.year().number, 474);
272274
/// assert_eq!(datetime_persian.date.month().ordinal, 10);

0 commit comments

Comments
 (0)