Skip to content

Commit e5e926e

Browse files
committed
Change docs to refer to "currently configured time zone"
The "timezone of an instant" is a misnomer because the `instant` type doesn't carry timezone information. The host has a currently configured time zone (or has no such concept, in which case the only sensible thing to do is use UTC).
1 parent f1a63db commit e5e926e

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

wit-0.3.0-draft/timezone.wit

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ interface timezone {
55
@unstable(feature = clocks-timezone)
66
use system-clock.{instant};
77

8-
/// Return information needed to display the given `instant`. This includes
9-
/// the UTC offset, the time zone name, and a flag indicating whether
10-
/// daylight saving time is active.
8+
/// Return information needed to display the given `instant` in the
9+
/// currently configured time zone. This includes the UTC offset, the time
10+
/// zone name, and a flag indicating whether daylight saving time is active.
1111
///
12-
/// If the timezone cannot be determined for the given `instant`, return a
12+
/// If the currently configured timezone cannot be determined, return a
1313
/// `timezone-display` for `UTC` with a `utc-offset` of 0 and no daylight
1414
/// saving time.
1515
@unstable(feature = clocks-timezone)
@@ -19,7 +19,8 @@ interface timezone {
1919
@unstable(feature = clocks-timezone)
2020
utc-offset: func(when: instant) -> s32;
2121

22-
/// Information useful for displaying the timezone of a specific `instant`.
22+
/// Information useful for displaying a specific `instant` in the currently
23+
/// configured time zone.
2324
///
2425
/// This information may vary within a single `timezone` to reflect daylight
2526
/// saving time adjustments.

0 commit comments

Comments
 (0)