Fix some issues with slash commands & add missing docs (#46)

mctaylors: "but I use Rider too..."

Boyfriend.csproj

@@ -23,27 +23,10 @@
         <PackageReference Include="Humanizer.Core.ru" Version="2.14.1"/>
         <PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1"/>
         <PackageReference Include="Remora.Discord" Version="2023.3.0"/>
-    </ItemGroup>
 
-    <!--    TODO: remove this when done -->
-    <ItemGroup>
-        <Compile Remove="old\**" />
-        <Compile Update="Messages.Designer.cs">
-            <DesignTime>True</DesignTime>
-            <AutoGen>True</AutoGen>
-            <DependentUpon>Messages.resx</DependentUpon>
-        </Compile>
-    </ItemGroup>
-
-    <ItemGroup>
-        <EmbeddedResource Remove="old\**" />
         <EmbeddedResource Update="Messages.resx">
             <Generator>ResXFileCodeGenerator</Generator>
             <LastGenOutput>Messages.Designer.cs</LastGenOutput>
         </EmbeddedResource>
     </ItemGroup>
-
-    <ItemGroup>
-        <None Remove="old\**" />
-    </ItemGroup>
 </Project>

Commands/KickCommandGroup.cs

@@ -42,15 +42,15 @@ public class KickCommandGroup : CommandGroup {
     }
 
     /// <summary>
-    ///     A slash command that kicks a Discord user with the specified reason.
+    ///     A slash command that kicks a Discord member with the specified reason.
     /// </summary>
-    /// <param name="target">The user to kick.</param>
+    /// <param name="target">The member to kick.</param>
     /// <param name="reason">
     ///     The reason for this kick. Must be encoded with <see cref="Extensions.EncodeHeader" /> when passed to
     ///     <see cref="IDiscordRestGuildAPI.RemoveGuildMemberAsync" />.
     /// </param>
     /// <returns>
-    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the user
+    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the member
     ///     was kicked and vice-versa.
     /// </returns>
     [Command("kick", "кик")]

Commands/MuteCommandGroup.cs

@@ -44,16 +44,16 @@ public class MuteCommandGroup : CommandGroup {
     }
 
     /// <summary>
-    ///     A slash command that mutes a Discord user with the specified reason.
+    ///     A slash command that mutes a Discord member with the specified reason.
     /// </summary>
-    /// <param name="target">The user to mute.</param>
-    /// <param name="duration">The duration for this mute. The user will be automatically unmuted after this duration.</param>
+    /// <param name="target">The member to mute.</param>
+    /// <param name="duration">The duration for this mute. The member will be automatically unmuted after this duration.</param>
     /// <param name="reason">
     ///     The reason for this mute. Must be encoded with <see cref="Extensions.EncodeHeader" /> when passed to
     ///     <see cref="IDiscordRestGuildAPI.ModifyGuildMemberAsync" />.
     /// </param>
     /// <returns>
-    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the user
+    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the member
     ///     was muted and vice-versa.
     /// </returns>
     /// <seealso cref="UnmuteUserAsync" />
@@ -65,8 +65,7 @@ public class MuteCommandGroup : CommandGroup {
     public async Task<Result> MuteUserAsync(
         [Description("Member to mute")] IUser    target,
         [Description("Mute reason")]    string   reason,
-        [Description("Mute duration")]
-        TimeSpan duration) {
+        [Description("Mute duration")]  TimeSpan duration) {
         if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var userId))
             return Result.FromError(
                 new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
@@ -156,15 +155,15 @@ public class MuteCommandGroup : CommandGroup {
     }
 
     /// <summary>
-    ///     A slash command that unmutes a Discord user with the specified reason.
+    ///     A slash command that unmutes a Discord member with the specified reason.
     /// </summary>
-    /// <param name="target">The user to unmute.</param>
+    /// <param name="target">The member to unmute.</param>
     /// <param name="reason">
     ///     The reason for this unmute. Must be encoded with <see cref="Extensions.EncodeHeader" /> when passed to
     ///     <see cref="IDiscordRestGuildAPI.ModifyGuildMemberAsync" />.
     /// </param>
     /// <returns>
-    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the user
+    ///     A feedback sending result which may or may not have succeeded. A successful result does not mean that the member
     ///     was unmuted and vice-versa.
     /// </returns>
     /// <seealso cref="MuteUserAsync" />
@@ -175,10 +174,8 @@ public class MuteCommandGroup : CommandGroup {
     [RequireBotDiscordPermissions(DiscordPermission.ModerateMembers)]
     [Description("Unmute member")]
     public async Task<Result> UnmuteUserAsync(
-        [Description("Member to unmute")]
-        IUser target,
-        [Description("Unmute reason")]
-        string reason) {
+        [Description("Member to unmute")] IUser  target,
+        [Description("Unmute reason")]    string reason) {
         if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var userId))
             return Result.FromError(
                 new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));

Commands/RemindCommandGroup.cs

@@ -33,9 +33,18 @@ public class RemindCommandGroup : CommandGroup {
         _userApi = userApi;
     }
 
+    /// <summary>
+    ///     A slash command that schedules a reminder with the specified text.
+    /// </summary>
+    /// <param name="in">The period of time which must pass before the reminder will be sent.</param>
+    /// <param name="message">The text of the reminder.</param>
+    /// <returns>A feedback sending result which may or may not have succeeded.</returns>
     [Command("remind")]
     [Description("Create a reminder")]
-    public async Task<Result> AddReminderAsync(TimeSpan duration, string text) {
+    public async Task<Result> AddReminderAsync(
+        [Description("After what period of time mention the reminder")]
+        TimeSpan @in,
+        [Description("Reminder message")] string message) {
         if (!_context.TryGetContextIDs(out var guildId, out var channelId, out var userId))
             return Result.FromError(
                 new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
@@ -44,13 +53,13 @@ public class RemindCommandGroup : CommandGroup {
         if (!userResult.IsDefined(out var user))
             return Result.FromError(userResult);
 
-        var remindAt = DateTimeOffset.UtcNow.Add(duration);
+        var remindAt = DateTimeOffset.UtcNow.Add(@in);
 
         (await _dataService.GetMemberData(guildId.Value, userId.Value, CancellationToken)).Reminders.Add(
             new Reminder {
                 RemindAt = remindAt,
                 Channel = channelId.Value,
-                Text = text
+                Text = message
             });
 
         var embed = new EmbedBuilder().WithSmallTitle(string.Format(Messages.ReminderCreated, user.GetTag()), user)

Commands/SettingsCommandGroup.cs

@@ -5,11 +5,8 @@ using Boyfriend.Data;
 using Boyfriend.Services;
 using Remora.Commands.Attributes;
 using Remora.Commands.Groups;
-using Remora.Discord.API.Abstractions.Objects;
 using Remora.Discord.API.Abstractions.Rest;
-using Remora.Discord.Commands.Attributes;
 using Remora.Discord.Commands.Contexts;
-using Remora.Discord.Commands.Feedback.Messages;
 using Remora.Discord.Commands.Feedback.Services;
 using Remora.Discord.Extensions.Embeds;
 using Remora.Discord.Extensions.Formatting;
@@ -46,8 +43,7 @@ public class SettingsCommandGroup : CommandGroup {
     /// </returns>
     [Command("settingslist")]
     [Description("Shows settings list for this server")]
-    [SuppressInteractionResponse(suppress: true)]
-    public async Task<Result> SendSettingsListAsync() {
+    public async Task<Result> ListSettingsAsync() {
         if (!_context.TryGetContextIDs(out var guildId, out _, out _))
             return Result.FromError(
                 new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
@@ -77,21 +73,21 @@ public class SettingsCommandGroup : CommandGroup {
             .Build();
         if (!embed.IsDefined(out var built)) return Result.FromError(embed);
 
-        return (Result)await _feedbackService.SendContextualEmbedAsync(
-            built, ct: CancellationToken, options: new FeedbackMessageOptions(MessageFlags: MessageFlags.Ephemeral));
+        return (Result)await _feedbackService.SendContextualEmbedAsync(built, ct: CancellationToken);
     }
 
     /// <summary>
     /// A slash command that modifies per-guild settings.
     /// </summary>
-    /// <returns>
-    ///     A feedback sending result which may or may not have succeeded.
-    /// </returns>
+    /// <param name="setting">The setting to modify.</param>
+    /// <param name="value">The new value of the setting.</param>
+    /// <returns>A feedback sending result which may or may not have succeeded.</returns>
     [Command("settings")]
     [Description("Change settings for this server")]
     public async Task<Result> EditSettingsAsync(
-        [Description("настройка")] string setting,
-        [Description("значение")]  string value) {
+        [Description("The setting whose value you want to change")]
+        string setting,
+        [Description("Setting value")] string value) {
         if (!_context.TryGetContextIDs(out var guildId, out _, out _))
             return Result.FromError(
                 new ArgumentNullError(nameof(_context), "Unable to retrieve necessary IDs from command context"));
@@ -147,7 +143,7 @@ public class SettingsCommandGroup : CommandGroup {
             .Append($" {Messages.SettingIsNow} ")
             .Append(Markdown.InlineCode(value));
 
-        var embed = new EmbedBuilder().WithSmallTitle(Messages.SettingSuccessfulyChanged, currentUser)
+        var embed = new EmbedBuilder().WithSmallTitle(Messages.SettingSuccessfullyChanged, currentUser)
             .WithDescription(builder.ToString())
             .WithColour(ColorsList.Green)
             .Build();

Extensions.cs

@@ -159,7 +159,7 @@ public static class Extensions {
                 builder.AppendLine(line.Text);
         }
 
-        return Markdown.BlockCode(builder.ToString().SanitizeForBlockCode(), "diff");
+        return InBlockCode(builder.ToString());
     }
 
     public static string GetTag(this IUser user) {

Messages.resx

@@ -549,8 +549,8 @@
     <data name="SettingsListTitle" xml:space="preserve">
         <value>Boyfriend's Settings</value>
     </data>
-    <data name="SettingSuccessfulyChanged" xml:space="preserve">
-        <value>Setting successfuly changed</value>
+    <data name="SettingSuccessfullyChanged" xml:space="preserve">
+        <value>Setting successfully changed</value>
     </data>
     <data name="SettingNotChanged" xml:space="preserve">
         <value>Setting not changed</value>

Messages.ru.resx

@@ -549,7 +549,7 @@
     <data name="SettingsListTitle" xml:space="preserve">
         <value>Настройки Boyfriend</value>
     </data>
-    <data name="SettingSuccessfulyChanged" xml:space="preserve">
+    <data name="SettingSuccessfullyChanged" xml:space="preserve">
         <value>Настройка успешно изменена</value>
     </data>
     <data name="SettingNotChanged" xml:space="preserve">

Messages.tt-ru.resx

@@ -549,7 +549,7 @@
     <data name="SettingsListTitle" xml:space="preserve">
         <value>приколы Boyfriend</value>
     </data>
-    <data name="SettingSuccessfulyChanged" xml:space="preserve">
+    <data name="SettingSuccessfullyChanged" xml:space="preserve">
         <value>прикол редактирован</value>
     </data>
     <data name="SettingNotChanged" xml:space="preserve">

docs/README.md

@@ -43,6 +43,6 @@ the most effective way possible.
 [JetBrains](https://www.jetbrains.com/), creators of [ReSharper](https://www.jetbrains.com/resharper)
 and [Rider](https://www.jetbrains.com/rider), supports Boyfriend with one of
 their [Open Source Licenses](https://jb.gg/OpenSourceSupport).
-Rider is the recommended IDE when working with Boyfriend, and most of the Boyfriend team uses it.
+Rider is the recommended IDE when working with Boyfriend, and everyone on the Boyfriend team uses it.
 Additionally, ReSharper command-line tools made by JetBrains are used for status checks on pull requests to ensure code
 quality even when not using ReSharper or Rider.