Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for ScheduledEvent.recurrence_rule #7058

Merged
merged 5 commits into from
Aug 6, 2024

Conversation

DV8FromTheWorld
Copy link
Member

Adds documentation for the guild_scheduled_event's recurrence_rule.
As is evidenced in the documentation, the recurrence_rule is heavily restricted right now and is based on the current limitations present in the app.

Solves:

@DV8FromTheWorld DV8FromTheWorld requested a review from a team as a code owner August 5, 2024 20:47
@DV8FromTheWorld DV8FromTheWorld requested review from shaydewael and removed request for a team August 5, 2024 20:47
@DV8FromTheWorld
Copy link
Member Author

Note, awaiting a PR merge in the discord_developers wrapping to support the new warning icon type

@colinloretz colinloretz self-requested a review August 5, 2024 21:08
@advaith1 advaith1 linked an issue Aug 5, 2024 that may be closed by this pull request
Copy link
Contributor

@colinloretz colinloretz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DV8FromTheWorld added a suggestion for the broken link 🚀

Comment on lines +145 to +151
- The following are current allowed "sets"
- Monday - Friday (`[0, 1, 2, 3, 4]`)
- Tuesday - Saturday (`[1, 2, 3, 4, 5]`)
- Sunday - Thursday (`[6, 0, 1, 2, 3]`)
- Friday & Saturday (`[4, 5]`)
- Saturday & Sunday (`[5, 6]`)
- Sunday & Monday (`[6, 0]`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one interesting thing we could note here is that we store the times in UTC. This means that a user in a different timezone may schedule an event for their Saturday/Sunday but this will actually be stored as Sunday/Monday. That's why those types of sets are allowed.

Co-authored-by: Colin Loretz <colin.loretz@discordapp.com>
@DV8FromTheWorld DV8FromTheWorld merged commit 4890918 into main Aug 6, 2024
4 checks passed
@DV8FromTheWorld DV8FromTheWorld deleted the chore/scheduled-event-recurrence-rule branch August 6, 2024 14:29
@DV8FromTheWorld DV8FromTheWorld restored the chore/scheduled-event-recurrence-rule branch August 6, 2024 14:30
sebm253 added a commit to disgoorg/disgo that referenced this pull request Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing documentation for recurrence_rule in Guild Scheduled Event
3 participants