Ian Cook created ARROW-13700:
--------------------------------
Summary: [Docs][C++] Clarify DayOfWeekOptions args
Key: ARROW-13700
URL: https://issues.apache.org/jira/browse/ARROW-13700
Project: Apache Arrow
Issue Type: Improvement
Components: C++, Documentation
Reporter: Ian Cook
Minor docs improvement suggestion:
The docs for {{DayOfWeekOptions}} say:
{quote}{{bool one_based_numbering}}
Number days from 1 if true and from 0 if false.
{{uint32_t week_start}}
What day does the week start with (Monday=1, Sunday=7)
{quote}
This might confuse some users into thinking that the meaning of {{week_start}}
is dependent on the value of {{one_based_numbering}}. For example, some users
might think that if they set {{one_based_numbering=0}}, then {{week_start=1}}
will be interpreted to mean Sunday instead of Monday.
Add a sentence in the docs explaining that the meaning of number passed to
{{week_start}} is unaffected by the choice of {{one_based_numbering}}.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
