Update CalendarEvent table to include a mention of required timezone

This commit is contained in:
Allen Porter 2022-03-30 14:48:30 +00:00
parent 8b03cd649e
commit 5edf0f2b1d

View File

@ -50,9 +50,9 @@ class MyCalendar(CalendarEntity):
A `CalendarEvent` represents an individual event on a calendar. A `CalendarEvent` represents an individual event on a calendar.
| Name | Type | Default | Description | | Name | Type | Default | Description |
| ----------- | ---------------- | ------------ | -------------------------------------------------------------------- | | ----------- | ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| start | datetime or date | **Required** | The start (inclusive) of the event. Must be before `end`. Both `start` and `end` must be the same type. | | start | datetime or date | **Required** | The start (inclusive) of the event. Must be before `end`. Both `start` and `end` must be the same type. As a datetime, must be in UTC timezone. |
| end | datetime or date | **Required** | The end (exclusive) of the event. Must be after `start`. | | end | datetime or date | **Required** | The end (exclusive) of the event. Must be after `start`. As a datetime, must be in UTC timezone. |
| summary | string | **Required** | A title or summary of the event. | | summary | string | **Required** | A title or summary of the event. |
| location | string | `None` | A geographic location of the event. | | location | string | `None` | A geographic location of the event. |
| description | string | `None` | A detailed description of the event. | | description | string | `None` | A detailed description of the event. |