update documentation for UNIX_EPOCH and comparison between SystemTimes to clarify handling of failure
#151685
+28
−17
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.
This documentation change is meant to clarify that
SystemTimes may (platform-dependently) be "less" than theUNIX_EPOCHand a developer ought to take care in comparing between the two, as this might lead to an error. It also explicitly mentionsSystemTimeError::durationfor when such an error does occur.I'm not sure on whether it would be helpful to document such a thing on the
SystemTimeitself rather than on it's methods and assoc consts? Perhaps it could be, since the documentation for the item also mentions theUNIX_EPOCHanchor and encourages comparisons with it. Anyways, open to suggestions.closes #52522