Docs: Add some notes about timezones and UTC to Time #54256
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
mhilbrunner
changed the title
akien-mga
reviewed
Oct 26, 2021
akien-mga
reviewed
Oct 26, 2021
mhilbrunner
force-pushed
the
docs-real-time
branch
from
68467b9
to
396d2f0
Compare
|
Updated, fixed :) |
akien-mga
approved these changes
Oct 26, 2021
|
Thanks! |
aaronfranke
reviewed
Oct 26, 2021
| </description> | ||
| </method> | ||
| <method name="get_unix_time_from_datetime_string" qualifiers="const"> | ||
| <return type="int" /> | ||
| <argument index="0" name="datetime" type="String" /> | ||
| <description> | ||
| Converts the given ISO 8601 date and/or time string to a Unix timestamp. The string can contain a date only, a time only, or both. | ||
| [b]Note:[/b] Unix timestamps are usually in UTC, the given datetime string may not be. |
There was a problem hiding this comment.
The timestamp will be equivalent to whatever datetime string is given. It doesn't do any conversion. If the string is a time offset from UTC, the timestamp will be too. The docs are not incorrect, but I think this could be phrased better.
There was a problem hiding this comment.
I agree, I'm not against improving the wording if you have a suggestion. :)
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.
Repeats some warnings/notes from the class description in the appropriate methods, also adding some notes about UTC/timezones and bit size/wrapping of values.
Should fix #52951.