doryan
/
gluon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Dogma Toscarina 2024-06-07 01:50:05 +03:00
parent e52d6042a3
commit 480cb335bd
2 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/assets/mute_command_help.html
View File

@ -1,10 +1,10 @@
<code>/mute [ID | REPLY] &lt;DURATION: i64 (long long int)&gt; [TIME METRIC]</code> <code>/mute [ID] &lt;DURATION&gt; [TIME METRIC]</code>
<b>Обязательные критерий:</b> <b>Выдать мут участнику чата.</b>
<b><em>1. Участник чата</em></b>. Введите ID участника чата, либо ответьте на его сообщение, чтобы его замьютить; Использовать при ответе на сообщение или указать <code>ID</code> пользователя.
<b><em>2. Длительность</em></b>. Введите длительность мьюта, длительность должна быть не меньше нуля.
<b>Необязательные критерий:</b> <i>DURATION<i> - длительность мута.
<i>TIME METRIC<i> - метрика времени в секундах, минутах, часах и днях ([s|min|h|d|w|m]/[с|мин|ч|д|н|м]); по умолчанию используются дни.
<b><em>1. Временная метрика.</em></b> Если она не указана, то автоматически участнику чата выдаётся мьют в днях. Доступно для пользователей с административными привилегиями в чате.

7
src/assets/unmute_command_help.html
View File

@ -1,6 +1,7 @@
<code>/unmute [ID | REPLY]</code> <code>/unmute [ID]</code>
<b>Обязательные критерий:</b> <b>Снять мут с участника чата.</b>
<b><em>1. Участник чата</em></b>. Введите ID участника чата, либо ответьте на его сообщение, чтобы c него снять мьют. Использовать при ответе на сообщение или указать <code>ID</code> пользователя.
Доступно для пользователей с административными привилегиями в чате.