rok commented on a change in pull request #11026:
URL: https://github.com/apache/arrow/pull/11026#discussion_r714860968
##########
File path: cpp/src/arrow/compute/api_scalar.h
##########
@@ -1006,17 +1023,20 @@ ARROW_EXPORT Result<Datum> DayOfYear(const Datum&
values, ExecContext* ctx = NUL
ARROW_EXPORT
Result<Datum> ISOYear(const Datum& values, ExecContext* ctx = NULLPTR);
-/// \brief ISOWeek returns ISO week of year number for each element of
`values`.
+/// \brief Week returns week of year number for each element of `values`.
/// First ISO week has the majority (4 or more) of its days in January.
-/// Week of the year starts with 1 and can run up to 53.
+/// Year can have 52 or 53 weeks. Week numbering can start with 0 or 1
+/// depending on DayOfWeekOptions.count_from_zero.
///
-/// \param[in] values input to extract ISO week of year from
+/// \param[in] values input to extract week of year from
+/// \param[in] options for setting numbering start
/// \param[in] ctx the function execution context, optional
/// \return the resulting datum
///
-/// \since 5.0.0
+/// \since 6.0.0
/// \note API not yet finalized
-ARROW_EXPORT Result<Datum> ISOWeek(const Datum& values, ExecContext* ctx =
NULLPTR);
+ARROW_EXPORT Result<Datum> Week(const Datum& values, WeekOptions options =
WeekOptions(),
+ ExecContext* ctx = NULLPTR);
Review comment:
Done.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
