TeamInklings/OctobotStealth
TeamInklings/OctobotStealth
Archived
1
0
Fork 0
forked from TeamInklings/Octobot
Code Pull requests Wiki Activity Actions

Add time format example to the description of commands that use TimeSpan. (#267)

Browse source 
This PR was made to help users who are trying /remind for the first time
by showing an example of the correct time format in the description.

---------

Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
This commit is contained in:
Macintxsh 2024-03-17 16:46:53 +03:00 committed by GitHub
parent 8eed295fcd
commit 62709d927b
Signed by: GitHub
GPG key ID: B5690EEEBB952194
8 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
locale/Messages.resx
View file

@ -654,4 +654,7 @@
<data name="EightBallNegative5" xml:space="preserve">
<value>Very doubtful</value>
</data>
<data name="TimeSpanExample" xml:space="preserve">
<value>Example of a valid input: `1h30m`</value>
</data>
</root>

3
locale/Messages.ru.resx
View file

@ -654,4 +654,7 @@
<data name="EightBallNegative5" xml:space="preserve">
<value>Весьма сомнительно</value>
</data>
<data name="TimeSpanExample" xml:space="preserve">
<value>Пример правильного ввода: `1ч30м`</value>
</data>
</root>

3
locale/Messages.tt-ru.resx
View file

@ -654,4 +654,7 @@
<data name="EightBallNegative5" xml:space="preserve">
<value>чот сомневаюсь</value>
</data>
<data name="TimeSpanExample" xml:space="preserve">
<value>правильно пишут так: `1h30m`</value>
</data>
</root>

4
src/Commands/BanCommandGroup.cs
View file

@ -76,7 +76,8 @@ public class BanCommandGroup : CommandGroup
[Description("User to ban")] IUser target,
[Description("Ban reason")] [MaxLength(256)]
string reason,
[Description("Ban duration")] string? duration = null)
[Description("Ban duration (e.g. 1h30m)")]
string? duration = null)
{
if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var executorId))
{
@ -116,6 +117,7 @@ public class BanCommandGroup : CommandGroup
{
var failedEmbed = new EmbedBuilder()
.WithSmallTitle(Messages.InvalidTimeSpan, bot)
.WithDescription(Messages.TimeSpanExample)
.WithColour(ColorsList.Red)
.Build();

3
src/Commands/MuteCommandGroup.cs
View file

@ -73,7 +73,7 @@ public class MuteCommandGroup : CommandGroup
[Description("Member to mute")] IUser target,
[Description("Mute reason")] [MaxLength(256)]
string reason,
[Description("Mute duration")] [Option("duration")]
[Description("Mute duration (e.g. 1h30m)")] [Option("duration")]
string stringDuration)
{
if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var executorId))
@ -111,6 +111,7 @@ public class MuteCommandGroup : CommandGroup
{
var failedEmbed = new EmbedBuilder()
.WithSmallTitle(Messages.InvalidTimeSpan, bot)
.WithDescription(Messages.TimeSpanExample)
.WithColour(ColorsList.Red)
.Build();

4
src/Commands/RemindCommandGroup.cs
View file

@ -120,7 +120,7 @@ public class RemindCommandGroup : CommandGroup
[RequireContext(ChannelContext.Guild)]
[UsedImplicitly]
public async Task<Result> ExecuteReminderAsync(
[Description("After what period of time mention the reminder")]
[Description("After what period of time mention the reminder (e.g. 1h30m)")]
[Option("in")]
string timeSpanString,
[Description("Reminder text")] [MaxLength(512)]
@ -151,6 +151,7 @@ public class RemindCommandGroup : CommandGroup
{
var failedEmbed = new EmbedBuilder()
.WithSmallTitle(Messages.InvalidTimeSpan, bot)
.WithDescription(Messages.TimeSpanExample)
.WithColour(ColorsList.Red)
.Build();
@ -264,6 +265,7 @@ public class RemindCommandGroup : CommandGroup
{
var failedEmbed = new EmbedBuilder()
.WithSmallTitle(Messages.InvalidTimeSpan, bot)
.WithDescription(Messages.TimeSpanExample)
.WithColour(ColorsList.Red)
.Build();

1
src/Commands/ToolsCommandGroup.cs
View file

@ -461,6 +461,7 @@ public class ToolsCommandGroup : CommandGroup
{
var failedEmbed = new EmbedBuilder()
.WithSmallTitle(Messages.InvalidTimeSpan, bot)
.WithDescription(Messages.TimeSpanExample)
.WithColour(ColorsList.Red)
.Build();

6
src/Messages.Designer.cs generated
View file

@ -1178,5 +1178,11 @@ namespace Octobot {
return ResourceManager.GetString("EightBallNegative5", resourceCulture);
}
}
internal static string TimeSpanExample {
get {
return ResourceManager.GetString("TimeSpanExample", resourceCulture);
}
}
}
}