[ARROW-13700] [Docs][C++] Clarify DayOfWeekOptions args

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 6.0.0
• Component/s: C++, Documentation
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/29335
• Assignee: Rok Mihevc
• Reporter: Ian Cook
• Created: 23/Aug/21 18:47
• Updated: 11/Jan/23 08:34
• Resolved: 30/Sep/21 17:38

Description

Minor docs improvement suggestion:

The docs for DayOfWeekOptions say: 

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)

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.

Issue Links

• links to: GitHub Pull Request #11251