Document that date math is locale independent

With this commit we add a note to the API conventions documentation that
all date math expressions are resolved independently of any locale. This
behavior might be puzzling to users that try to specify a different
calendar than a Gregorian calendar.

Closes #37330 
Relates #37663
This commit is contained in:
Daniel Mitterdorfer 2019-01-22 12:04:29 +01:00 committed by GitHub
parent 5db7ed22a0
commit 757932a975
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions

View File

@ -85,6 +85,9 @@ Where:
`date_format`:: is the optional format in which the computed date should be rendered. Defaults to `YYYY.MM.dd`. `date_format`:: is the optional format in which the computed date should be rendered. Defaults to `YYYY.MM.dd`.
`time_zone`:: is the optional time zone . Defaults to `utc`. `time_zone`:: is the optional time zone . Defaults to `utc`.
Date math expressions are resolved locale-independent. Consequently, it is not possible to use any other
calendars than the Gregorian calendar.
You must enclose date math index name expressions within angle brackets, and You must enclose date math index name expressions within angle brackets, and
all special characters should be URI encoded. For example: all special characters should be URI encoded. For example: