Skip to content

Commit ccc79d1

Browse files
committed
Update documentation to mention events crossing years
1 parent 968aa2f commit ccc79d1

2 files changed

Lines changed: 1 addition & 2 deletions

File tree

events/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ start_date: July 10
2323
end_date: July 20
2424
```
2525
26-
There must be exactly 1 fallback event, and 0 or more non-fallback events. Events cannot collide in time, and the end date must either be equal to the start date (1 day event) or chronologically subsequent. Both bounds are inclusive, and the format shown in the example above must be followed.
26+
There must be exactly 1 fallback event, and 0 or more non-fallback events. If start_date is a later day in the year than end_date, the event is interpreted as starting in one year and ending in the next. Both bounds are inclusive, and the format shown in the example above must be followed.
2727
2828
The markdown section of the meta file then contains the event's description. Descriptions are made available directly in the Discord guild as embeds sent by the Python bot. For formatting, use Discord's watered down Markdown ~ keep in mind that e.g. the `#` symbol does not create a heading.
2929

events/validation.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
We check that each event directory satisfies the following:
1010
* Contains 'meta.md', `banners/` and 'server_icons/' with at least 1 file inside each
1111
* The 'meta.md' file either registers the event as fallback, or specifies the start and end dates
12-
* The end date must either be the same as the start date, or chronologically subsequent
1312
* The 'meta.md' file contains an event description between 1 and 2048 characters in length
1413
1514
If all events are set up correctly, we also validate that:

0 commit comments

Comments
 (0)