sascha_hemi/hacs_waste_collection_schedule
1
0
Fork 0
mirror of https://github.com/sascha-hemi/hacs_waste_collection_schedule.git synced 2026-03-21 00:04:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

make clear that either until or count is required for static source

Browse Source 
Otherwise you will get only the next 10 events, which is most probably not what you want.
This commit is contained in:
mampfes
2023-06-21 08:21:07 +02:00
parent ea273919e3
commit 64cf881ed2
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/static.md
View File

@@ -30,29 +30,29 @@ The type of this source.
**DATES**
*(list) (optional)*
A list of dates in format "YYYY-MM-DD" which should be added to the source.
A list of dates in format `YYYY-MM-DD` which should be added to the source.
Dates defined in this list will be added in addition to calculated dates from the recurrence and will not be affected by the exclude-list.
**FREQUENCY**
*(string) (optional)*
Defines the frequency of the recurrence. Must be one of "DAILY", "WEEKLY", "MONTHLY" or "YEARLY".
Defines the frequency of the recurrence. Must be one of `DAILY`, `WEEKLY`, `MONTHLY` or `YEARLY`.
**INTERVAL**
*(int) (optional, default: ```1```)*
*(int) (optional, default: `1`)*
Defines the interval of the recurrence.
**START**
*(string) (optional)*
Defines the start of the recurrence in the format "YYYY-MM-DD".
Required if *FREQUENCY* is set.
Defines the start of the recurrence in the format `YYYY-MM-DD`.
Required if `frequency` is set. Always add either `until` or `count`, otherwise you will get only the next 10 events after start.
**UNTIL**
*(string) (optional)*
Defines the end of the recurrence in the format "YYYY-MM-DD".
Defines the end of the recurrence in the format `YYYY-MM-DD`.
**COUNT**
*(int) (optional)*
@@ -62,14 +62,14 @@ Defines the (maximum) number of returned dates. Only used if `until` is not spec
**EXCLUDES**
*(list) (optional)*
A list of dates in format "YYYY-MM-DD" which should be excluded from the recurrence.
A list of dates in format `YYYY-MM-DD` which should be excluded from the recurrence.
**WEEKDAYS**
*(weekday | dictionary of weekday and occurrence) (optional)*
Used to define the weekday for weekly or monthly frequencies. A weekday is specified by the following weekday constants: `MO, TU, WE, TH, FR, SA, SU`.
`WEEKDAYS` can be specified in one of the following formats:
`weekdays` can be specified in one of the following formats:
1. Single Weekday:
@@ -151,4 +151,5 @@ waste_collection_schedule:
frequency: WEEKLY
interval: 2
start: '2023-02-01'
until: '2023-12-31'
```