Docs: Fix incorrect explanations and examples about ZonedDateTime #2514
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
Codecov Report
@@ Coverage Diff @@
## main #2514 +/- ##
=======================================
Coverage 95.49% 95.49%
=======================================
Files 20 20
Lines 10923 10923
Branches 2031 2031
=======================================
Hits 10431 10431
Misses 430 430
Partials 62 62 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
justingrant
approved these changes
Mar 3, 2023
| @@ -1224,7 +1223,7 @@ Compares two `Temporal.ZonedDateTime` objects for equality. | |||
| This function exists because it's not possible to compare using `zonedDateTime == other` or `zonedDateTime === other`, due to ambiguity in the primitive representation and between Temporal types. | |||
|
|
|||
| If you don't need to know the order in which two events occur, then this function is easier to use than `Temporal.ZonedDateTime.compare`. | |||
| But both methods do the same thing, so a `0` returned from `compare` implies a `true` result from `equals`, and vice-versa. | |||
| However, there are subtle differences between the two methods—a `true` result from `equals` includes comparison of calendar and time zone, and is therefore stronger than a `0` result from compare (which ignores calendar and time zone). | |||
There was a problem hiding this comment.
Good catch. The old docs were how it used to work before we were required to switch to the current behavior as a condition of getting Stage 3!
Aditi-1400
pushed a commit
to Aditi-1400/proposal-temporal
that referenced
this pull request
Mar 7, 2023
…39#2514) * Correct false claim about ZonedDateTime.prototype.equals * Correct false example for ZonedDateTime.compare * Clarify and improve cross-type alignment of ZonedDateTime.compare
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.
No description provided.