Skip to content

Commit 79c91c2

Browse files
authored
Update documentation (#77)
* Update doc with new !listreminders format * add space after alarm emoji * add some secret shorthands to the help message
1 parent ba748f8 commit 79c91c2

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

matrix_reminder_bot/bot_commands.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -418,11 +418,19 @@ async def _remove_and_silence_alarm(self, alarm_job: Job, reminder_text: str):
418418
async def _list_reminders(self):
419419
"""Format and show known reminders for the current room
420420
421-
Sends a message listing them in the following format:
421+
Sends a message listing them in the following format, using the alarm clock emoji ⏰ to indicate an alarm:
422422
423-
Reminders for this room:
423+
1️⃣ One-time Reminders
424424
425-
<start time>: <reminder text> [(every <recurring time>)] [(has alarm)]
425+
* [⏰] <start time>: <reminder text>
426+
427+
📅 Cron Reminders
428+
429+
* [⏰] m h d M wd (`m h d M wd`); next run in <rounded next time>; <reminder text>
430+
431+
🔁 Repeating Reminders
432+
433+
* [⏰] every <recurring time>; next run in <rounded next time>; <reminder text>
426434
427435
or if there are no reminders set:
428436
@@ -445,7 +453,7 @@ async def _list_reminders(self):
445453
if reminder.alarm:
446454
# Note that an alarm exists if available
447455
alarm_clock_emoji = "⏰"
448-
line += alarm_clock_emoji
456+
line += alarm_clock_emoji + " "
449457

450458
# Print the duration before (next) execution
451459
next_execution = reminder.job.next_run_time
@@ -566,13 +574,13 @@ async def _help(self):
566574
List all active reminders for a room:
567575
568576
```
569-
{c}listreminders|list|lr
577+
{c}listreminders|list|lr|l
570578
```
571579
572580
Cancel a reminder:
573581
574582
```
575-
{c}cancelreminder|cancel|c <reminder text>
583+
{c}cancelreminder|cancel|cr|c <reminder text>
576584
```
577585
578586
**Alarms**

0 commit comments

Comments
 (0)