Skip to content

Commit 1c99700

Browse files
committed
Docs: Document that dayOfWeek, dayOfYear, and weekOfYear are 1-based
This is already documented in the spec text, but an issue was still open for adding it to the docs. Closes: #1225
1 parent eac411d commit 1c99700

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/calendar.md

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The following "invariants" (statements that are always true) hold for all built-
4747
- `obj.with({ month: 1, day: 1 })` will always return the first day of the object's year.
4848
- `obj.with({ month: obj.monthsInYear, day: Number.MAX_VALUE })` will always return the last day of the object's year.
4949
- `obj.month === obj.monthsInYear` during the last month of any year
50+
- `dayOfWeek`, `dayOfYear`, and `weekOfYear` are 1-based positive integers, that increase consecutively as time goes forward, except they reset at the boundary of a week or year, respectively
5051

5152
### Writing Cross-Calendar Code
5253

0 commit comments

Comments
 (0)