Add missed datetime information #4420

ligurio · 2024-08-08T08:54:40Z

Staging: https://docs.d.tarantool.io/en/doc/gh-xxxx-missed-datetime-information/reference/reference_lua/datetime/

Fixed typo in `input_string` and added default format string to description of `datetime.parse()`.

ligurio · 2024-08-09T10:29:28Z

doc/reference/reference_lua/datetime.rst

@@ -118,7 +118,7 @@ Functions
                -   0

            *   -   sec
-                -   Seconds. Value range: 0 - 60.
+                -   Seconds. Value range: 0 - 60. Leap second is supported, see a section :ref:`leap second <leap-second>`.


Link to section Leap second doesn't work. Andrey, could you help please? @andreyaksenov

Please add the following anchor before the Leap second section:

.. _leap-second: Leap second -----------

Fixed, thanks!

ligurio · 2024-08-09T10:29:37Z

doc/reference/reference_lua/datetime.rst

@@ -263,9 +263,14 @@ Functions
    *   RFC 3339
    *   extended `strftime <https://www.freebsd.org/cgi/man.cgi?query=strftime&sektion=3>`__ -- see description of the :ref:`format() <datetime-format>` for details.

+    By default fields that are not specified are equal to appropriate values in a Unix time.
+
+    Leap second is supported, see a section :ref:`leap second <leap-second>`.


Link to section Leap second doesn't work. Andrey, could you help please? @andreyaksenov

andreyaksenov

Please see my comments below.

andreyaksenov · 2024-08-09T12:04:12Z

doc/reference/reference_lua/datetime.rst

+
+This section describes how ``datetime`` module supports leap seconds:
+
+*   Tarantool includes TZDB (also called ``tzdata``) and uses this database


If I'm correct, we cannot say that TZDB is also called tzdata. While TZDB is a collection of information about the world's time zones, tzdata a specific package that contains the information from the TZDB.

Right, TZDB is a database with information about timezones and tzdata is a distribution package with other data (like leapsecond file), source code of programs and scripts. I'll fix it.

Paragraph was removed.

doc/reference/reference_lua/datetime.rst

andreyaksenov · 2024-08-09T12:26:37Z

doc/reference/reference_lua/datetime.rst

+    :ref:`datetime.now() <datetime-now>`, :ref:`datetime:set() <datetime-set>`
+    accept a table with seconds equal to 60 seconds:
+
+..  code-block:: tarantoolsession


Please add the 4-spaces indent before .. code-block:: tarantoolsession and the entire code block (the same for all code blocks inside lists).

I'd remove all the examples after datetime.new({ sec = 60 }). Look a bit excessive.

andreyaksenov · 2024-08-09T12:42:37Z

doc/reference/reference_lua/datetime.rst

+Limitations
+-----------
+
+The supported date range is from -5879610-06-22 to +5879611-07-11.


Do we really need the examples below? Adding examples for such corner cases is unnecessary in docs.

Okay, I'll remove it.

andreyaksenov · 2024-08-09T12:46:37Z

doc/reference/reference_lua/datetime.rst

+Leap second
+-----------
+
+Coordinated Universal Time (UTC) is based on International Atomic Time (TAI).


Honestly, such detailed info about the leap second looks excessive for Tarantool docs. Can we make a short intro about TZDB in general and the leap seconds in particular, give a link to the external resource, and then jump right to the point (which is how all of these apply to Tarantool)?

doc/reference/reference_lua/datetime.rst

andreyaksenov · 2024-08-09T12:51:28Z

doc/reference/reference_lua/datetime.rst

+    for a correct time zones support. Use Lua module :doc:`/reference/reference_lua/tarantool`
+    to get a used version of ``tzdata``:
+
+    Since: :doc:`3.2.0 </release/3.2.0>`


Since between the description and example looks weird. Ideally, we should describe all the fields in the Module tarantool docs and add the Since info there. As a workaround, let's update the previous sentence like this:

Since :doc:`3.2.0 </release/3.2.0>`, you can use the Lua module ....

Updated:

--- a/doc/reference/reference_lua/datetime.rst +++ b/doc/reference/reference_lua/datetime.rst @@ -1082,10 +1082,9 @@ implement the time zones support properly. This section describes how ``datetime`` module supports leap seconds: * Tarantool includes TZDB (also called ``tzdata``) and uses this database - for a correct time zones support. Use the Lua module :ref:`tarantool <tarantool-module>` - to get a used version of ``tzdata``: - - Since: :doc:`3.2.0 </release/3.2.0>` + for a correct time zones support. Since :doc:`3.2.0 </release/3.2.0>`, + you can use the Lua module :ref:`tarantool <tarantool-module>` to get + a used version of ``tzdata``: .. code-block:: tarantoolsession

but I've removed this paragraph for now, I'll add it in scope of doc request from #10387.

doc/reference/reference_lua/datetime.rst

andreyaksenov

Thanks! LGTM

andreyaksenov · 2024-08-09T14:43:48Z

doc/reference/reference_lua/datetime.rst

+the Earth's rotation speed varies in response to climatic and geological events,
+and due to this, UTC leap seconds are irregularly spaced and unpredictable.
+
+This section describes how ``datetime`` module supports leap seconds:


Suggested change

This section describes how ``datetime`` module supports leap seconds:

This section describes how the ``datetime`` module supports leap seconds:

Leap second was introduced in commit "datetime, lua: interval arithmetics" [1]. Fixes #4409 1. tarantool/tarantool@b0463da

Added a section with useful links.

`strptime` is a function, not a library.

ligurio added 2 commits August 7, 2024 16:47

datetime: default values in datetime.parse()

07bc462

Follows up tarantool/tarantool#8588

datetime: default format string in datetime.parse()

4b83d65

Fixed typo in `input_string` and added default format string to description of `datetime.parse()`.

ligurio marked this pull request as draft August 8, 2024 08:54

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch 3 times, most recently from faa039e to 18cb155 Compare August 8, 2024 15:44

ligurio changed the title ~~Missed datetime information~~ Add missed datetime information Aug 8, 2024

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch from 18cb155 to bba7a5c Compare August 9, 2024 10:25

ligurio commented Aug 9, 2024

View reviewed changes

ligurio marked this pull request as ready for review August 9, 2024 10:30

ligurio requested a review from andreyaksenov August 9, 2024 10:38

ligurio assigned andreyaksenov Aug 9, 2024

andreyaksenov suggested changes Aug 9, 2024

View reviewed changes

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch from f5c00c1 to 1fe8ca2 Compare August 9, 2024 14:30

ligurio requested a review from andreyaksenov August 9, 2024 14:40

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch 2 times, most recently from 8f71c4c to 6bd7ca0 Compare August 11, 2024 15:15

andreyaksenov linked an issue Aug 12, 2024 that may be closed by this pull request

feedback: datetime.new() | Tarantool #4409

Closed

andreyaksenov approved these changes Aug 12, 2024

View reviewed changes

datetime: describe leap second support

f7a0aa3

Leap second was introduced in commit "datetime, lua: interval arithmetics" [1]. Fixes #4409 1. tarantool/tarantool@b0463da

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch from 59f8ab9 to ff058d7 Compare August 12, 2024 08:22

ligurio and others added 4 commits August 12, 2024 11:35

leap

3dc2bd3

datetime: describe limitations

460c06f

datetime: add section with references

6478f1b

Added a section with useful links.

datetime: fix typo

a93eb89

`strptime` is a function, not a library.

ligurio force-pushed the ligurio/gh-xxxx-missed-datetime-information branch from ff058d7 to a93eb89 Compare August 12, 2024 08:35

andreyaksenov merged commit 70c8f78 into latest Aug 12, 2024
1 check passed

andreyaksenov deleted the ligurio/gh-xxxx-missed-datetime-information branch August 12, 2024 08:44


		This section describes how ``datetime`` module supports leap seconds:

		* Tarantool includes TZDB (also called ``tzdata``) and uses this database

	This section describes how ``datetime`` module supports leap seconds:
	This section describes how the ``datetime`` module supports leap seconds:

Add missed datetime information #4420

Add missed datetime information #4420

Uh oh!

Conversation

ligurio commented Aug 8, 2024 • edited by andreyaksenov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andreyaksenov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andreyaksenov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ligurio commented Aug 8, 2024 •

edited by andreyaksenov

Loading