diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-04-16 08:32:04 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-16 08:32:04 +0200 |
| commit | 50bb1846d0f16fae929b2ae99824dbf90be25c92 (patch) | |
| tree | e399f56ce6c869bbec7b25fe929881dfcf24a3e1 /doc/classes | |
| parent | 92eceb45ecda859bcad8e7a647466d535e11420f (diff) | |
| parent | 1b891069cd0ea672276888ea0e0159b5cedc5cc9 (diff) | |
Merge pull request #60267 from timothyqiu/timestamp-fraction
Document timestamp decimal fraction in `Time`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Time.xml | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/Time.xml b/doc/classes/Time.xml index dd83fa54ff..d3aac5fa00 100644 --- a/doc/classes/Time.xml +++ b/doc/classes/Time.xml @@ -50,6 +50,7 @@ <description> Converts the given ISO 8601 date and time string (YYYY-MM-DDTHH:MM:SS) to a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]hour[/code], [code]minute[/code], and [code]second[/code]. If [code]weekday[/code] is false, then the [code]weekday[/code] entry is excluded (the calculation is relatively expensive). + [b]Note:[/b] Any decimal fraction in the time string will be ignored silently. </description> </method> <method name="get_datetime_dict_from_system" qualifiers="const"> @@ -171,12 +172,14 @@ <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 often in UTC. This method does not do any timezone conversion, so the timestamp will be in the same timezone as the given datetime string. + [b]Note:[/b] Any decimal fraction in the time string will be ignored silently. </description> </method> <method name="get_unix_time_from_system" qualifiers="const"> <return type="float" /> <description> Returns the current Unix timestamp in seconds based on the system time in UTC. This method is implemented by the operating system and always returns the time in UTC. + [b]Note:[/b] Unlike other methods that use integer timestamps, this method returns the timestamp as a [float] for sub-second precision. </description> </method> </methods> |