pitrou commented on a change in pull request #10598:
URL: https://github.com/apache/arrow/pull/10598#discussion_r662209935
##########
File path: docs/source/cpp/compute.rst
##########
@@ -954,44 +954,46 @@ Temporal component extraction
These functions extract datetime components (year, month, day, etc) from
timestamp type.
Note: this is currently not supported for timestamps with timezone information.
-+--------------------+------------+-------------------+---------------+--------+
-| Function name | Arity | Input types | Output type | Notes
|
-+====================+============+===================+===============+========+
-| year | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| month | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| day | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| day_of_week | Unary | Temporal | Int64 | \(1)
|
-+--------------------+------------+-------------------+---------------+--------+
-| day_of_year | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| iso_year | Unary | Temporal | Int64 | \(2)
|
-+--------------------+------------+-------------------+---------------+--------+
-| iso_week | Unary | Temporal | Int64 | \(2)
|
-+--------------------+------------+-------------------+---------------+--------+
-| iso_calendar | Unary | Temporal | Struct | \(3)
|
-+--------------------+------------+-------------------+---------------+--------+
-| quarter | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| hour | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| minute | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| second | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| millisecond | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| microsecond | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| nanosecond | Unary | Temporal | Int64 |
|
-+--------------------+------------+-------------------+---------------+--------+
-| subsecond | Unary | Temporal | Double |
|
-+--------------------+------------+-------------------+---------------+--------+
-
-* \(1) Outputs the number of the day of the week. Week begins on Monday and is
denoted
- by 0 and ends on Sunday denoted by 6.
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| Function name | Arity | Input types | Output type | Notes
| Options class |
++====================+============+===================+===============+========+============================+
+| year | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| month | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| day | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| day_of_week | Unary | Temporal | Int64 | \(1)
| :struct:`DayOfWeekOptions` |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| day_of_year | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| iso_year | Unary | Temporal | Int64 | \(2)
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| iso_week | Unary | Temporal | Int64 | \(2)
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| iso_calendar | Unary | Temporal | Struct | \(3)
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| quarter | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| hour | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| minute | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| second | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| millisecond | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| microsecond | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| nanosecond | Unary | Temporal | Int64 |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+| subsecond | Unary | Temporal | Double |
| |
++--------------------+------------+-------------------+---------------+--------+----------------------------+
+
+* \(1) Outputs the number of the day of the week. By default week begins on
Monday
+ represented by 0 and ends on Sunday represented by 6.
:member:`DayOfWeekOptions::week_start` can be used to set
+ the starting day of the week using ISO convention (Monday=1, Sunday=7). Day
numbering can start with 0 or 1
+ using :member:`DayOfWeekOptions::week_start` parameter.
Review comment:
Probably not `week_start` here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
