From c6222d42f84839c627d655a899272b10149511a3 Mon Sep 17 00:00:00 2001 From: Dogma Toscarina Date: Fri, 7 Jun 2024 01:50:05 +0300 Subject: [PATCH] assets: fix help messages (mute, unmute) There are quite some problems with the way commands are explained: * Interactivity - command arguments gets explained as if one is following a guide ("insert this, enter that"). Better explain them without any "guidance"; use present tense to describe commands. * Duplicity - the purpose of the command is explained over and over when arguments are being described. * Separation - there is no need to divide required and optional command arguments into their respective sections. Their amount did not grow up that much for this to make sense. * mute_command_help.html: i64 would be sufficient for developers, but not end users. It does not stop anyone from specifying overflowing integer, after all. --- src/assets/mute_command_help.html | 12 ++++++------ src/assets/unmute_command_help.html | 7 ++++--- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/assets/mute_command_help.html b/src/assets/mute_command_help.html index 783141a..11a2948 100644 --- a/src/assets/mute_command_help.html +++ b/src/assets/mute_command_help.html @@ -1,10 +1,10 @@ -/mute [ID | REPLY] <DURATION: i64 (long long int)> [TIME METRIC] +/mute [ID | REPLY] <DURATION> [TIME METRIC] -Обязательные критерий: +Выдать мут участнику чата. -1. Участник чата. Введите ID участника чата, либо ответьте на его сообщение, чтобы его замьютить; -2. Длительность. Введите длительность мьюта, длительность должна быть не меньше нуля. +Использовать при ответе на сообщение или указать ID пользователя. -Необязательные критерий: +DURATION - длительность мута. +TIME METRIC - метрика времени в секундах, минутах, часах и днях ([s|min|h|d|w|m]/[с|мин|ч|д|н|м]); по умолчанию используются дни. -1. Временная метрика. Если она не указана, то автоматически участнику чата выдаётся мьют в днях. +Доступно для пользователей с административными привилегиями в чате. diff --git a/src/assets/unmute_command_help.html b/src/assets/unmute_command_help.html index 90f97f3..5f14ceb 100644 --- a/src/assets/unmute_command_help.html +++ b/src/assets/unmute_command_help.html @@ -1,6 +1,7 @@ -/unmute [ID | REPLY] +/unmute [ID | UNMUTE] -Обязательные критерий: +Снять мут с участника чата. -1. Участник чата. Введите ID участника чата, либо ответьте на его сообщение, чтобы c него снять мьют. +Использовать при ответе на сообщение или указать ID пользователя. +Доступно для пользователей с административными привилегиями в чате.