Improve time zone identifier docs #2492
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
justingrant
commented
Jan 29, 2023
justingrant
commented
- Adds a new section about time zone identifiers
- Adds new section to explain TZ identifier canonicalization
- Clarifies how identifiers and canonicalization work for custom TZs
- Various minor improvements related to IDs and canonicalization
Codecov Report
@@ Coverage Diff @@
## main #2492 +/- ##
=======================================
Coverage 96.05% 96.05%
=======================================
Files 20 20
Lines 11594 11594
Branches 2193 2193
=======================================
Hits 11137 11137
Misses 393 393
Partials 64 64 |
ptomato
requested changes
Aug 11, 2023
There was a problem hiding this comment.
@justingrant Sorry for letting this one go for so long. I had intended to merge it along with #2482, but I forgot about it. Unfortunately, not having done so meant that it didn't get updated when the time zone canonicalization proposal reached stage 3. I've tried to mark all the places where I think it needs to be updated, would you mind checking if I got it right?
justingrant
force-pushed
the
docs-custom-time-zone-ids
branch
2 times, most recently
from
c81fe4f
to
efbc554
Compare
justingrant
commented
Aug 11, 2023
| In any set of equivalent identifiers, only one identifier will be considered canonical. | ||
| To avoid redundancy, only canonical identifiers are returned by `Intl.supportedValuesOf('timeZone')`. | ||
| Furthermore, only canonical identifiers are output methods that returns the system's current time zone, such as `Temporal.Now.timeZoneId()`. | ||
| Other than those few cases, canonicalization is not observable in ECMAScript code, which ensures that changes to the IANA Time Zone Database will have minimal impact on the behavior of existing applications. |
There was a problem hiding this comment.
I can't believe how much work it took to be able to write that sentence! 😄
justingrant
force-pushed
the
docs-custom-time-zone-ids
branch
from
efbc554
to
32914b7
Compare
* Adds a new section about time zone identifiers * Various minor improvements related to IDs * Minor wordsmithing throughout the TimeZone docs
justingrant
force-pushed
the
docs-custom-time-zone-ids
branch
from
32914b7
to
eb1a72c
Compare
|
Content is rebased and all comments are resolved. @ptomato, want to take another look? Thanks! |
ptomato
approved these changes
Aug 11, 2023
|
That's another one off the list, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.