From 2ef26a390f1fb78c71bfe20f99e93b998bc961c1 Mon Sep 17 00:00:00 2001 From: Vollrat <29968697+Vollrat@users.noreply.github.com> Date: Tue, 3 Oct 2017 21:18:48 -0230 Subject: [PATCH 1/2] Improve Boolean Property Summaries Having the `CaseSensitiveCommands` property summary asking a question whenever Intellisense is invoked seems a bit nonessential instead of *properly* explaining what exactly it does. It would be better if instead, it stated it's use to be more comprehensible to the reader. ### Changes - Edits the summaries of `CaseSensitiveCommands` and `ThrowOnError` to follow a more methodical convention for boolean property summaries (`Determines whether X ...` rather than `Should X be ... ?`). This is just a small change to improve upon the current documentation, so it shouldn't conflict with anything. --- src/Discord.Net.Commands/CommandServiceConfig.cs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/Discord.Net.Commands/CommandServiceConfig.cs b/src/Discord.Net.Commands/CommandServiceConfig.cs index 5dcd50cd8..e9acc5101 100644 --- a/src/Discord.Net.Commands/CommandServiceConfig.cs +++ b/src/Discord.Net.Commands/CommandServiceConfig.cs @@ -6,13 +6,14 @@ public RunMode DefaultRunMode { get; set; } = RunMode.Sync; public char SeparatorChar { get; set; } = ' '; - /// Should commands be case-sensitive? + + /// Determines whether commands should be case-sensitive. public bool CaseSensitiveCommands { get; set; } = false; /// Gets or sets the minimum log level severity that will be sent to the Log event. public LogSeverity LogLevel { get; set; } = LogSeverity.Info; - /// Gets or sets whether RunMode.Sync commands should push exceptions up to the caller. + /// Determines whether RunMode.Sync commands should push exceptions up to the caller. public bool ThrowOnError { get; set; } = true; } -} \ No newline at end of file +} From 774cf4da55693493c9fc9573f552efb3e102f348 Mon Sep 17 00:00:00 2001 From: Vollrat <29968697+Vollrat@users.noreply.github.com> Date: Tue, 3 Oct 2017 21:19:54 -0230 Subject: [PATCH 2/2] "DefaultRunMode should also be "Gets or sets blah blah blah" to be consistent." --- src/Discord.Net.Commands/CommandServiceConfig.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Discord.Net.Commands/CommandServiceConfig.cs b/src/Discord.Net.Commands/CommandServiceConfig.cs index e9acc5101..b53b0248c 100644 --- a/src/Discord.Net.Commands/CommandServiceConfig.cs +++ b/src/Discord.Net.Commands/CommandServiceConfig.cs @@ -2,7 +2,7 @@ { public class CommandServiceConfig { - /// The default RunMode commands should have, if one is not specified on the Command attribute or builder. + /// Gets or sets the default RunMode commands should have, if one is not specified on the Command attribute or builder. public RunMode DefaultRunMode { get; set; } = RunMode.Sync; public char SeparatorChar { get; set; } = ' ';