Documentation Overhaul (#1161)

* Add XML docs * Clean up style switcher * Squash commits on branch docs/faq-n-patches * Fix broken theme selector * Add local image embed instruction * Add a bunch of XML docs * Add a bunch of XML docs * Fix broken search + DocFX by default ships with an older version of jQuery, switching to a newer version confuses parts of the DocFX Javascript. * Minor fixes for CONTRIBUTING.md and README.md * Clean up filterConfig.yml + New config exposes Discord.Net namespace since it has several common public exceptions that may be helpful to users * Add XML docs * Read token from Environment Variable instead of hardcode * Add XMLDocs * Compress some assets & add OAuth2 URL generator * Fix sample link & add missing pictures * Add tag examples * Fix embed docs consistency * Add details regarding userbot support * Add XML Docs * Add XML Docs * Add XML Docs * Minor fixes in documentations + Fix unescaped '<' + Fix typo * Fix seealso for preconditions and add missing descriptions * Add missing exceptions * Document exposed TypeReaders * Fix letter-casing for files * Add 'last modified' plugin Source: https://github.com/Still34/DocFx.Plugin.LastModified Licensed under MIT License * XML Docs * Fix minor consistencies & redundant impl * Add properties examples to overwrite * Fix missing Username prop * Add warning for bulk-delete endpoint * Replace note block * Add BaseSocketClient docs * Add XML docs * Replace langword null to code block null instead - Because DocFX sucks at rendering langword * Replace all langword placements with code block * Add more IGuild docs * Add details to SpotifyGame * Initial proofread of the articles * Add explanation for RunMode * Add event docs - MessageReceived - ChannelUpdated/Destroyed/Created * Fix light theme link color * Fix xml docs error * Add partial documentation for audit log impl * Add documentation for some REST-based objects * Add partial documentation for audit log objects * Add more XML comments to quotation mark alias map stuff, including an example * Add reference to CommandServiceConfig from the util docs' * Add explanation that if " is removed then it wont work * Fix missing service provider in example * Add documentation for new INestedChannel * Add documentation * Add documentation for new API version & few events * Revise guide paragraphs/samples + Fix various formatting. + Provide a more detailed walkthrough for dependency injection. + Add C# note at intro. * Fix typos & formatting * Improve group module example * Small amount to see if I'm doing it right * Remove/cleanup redundant variables * Fix EnterTypingState impl for doc inheritance * Fix Test to resolve changes made in 15b58e * Improve precondition documentation + Add precondition usage sample + Add precondition group usage sample + Move precondition samples to its own sample folder * Move samples to individual folders * Clarify token source * Cleanup styling of README.md for docs * Replace InvalidPathChars for NS1.3 * InvalidPathChars does not exist in NS1.3; replaced with GetInvalidPathChars instead. * Add a missing change for 2c7cc738 * Update LastModified to v1.1.0 & add license * Rewrite installation page for Core 2.1 * Fix anchor link * Bump post-processor to v1.1.1 * Add fixes to partial file & add license * Moved theme-switcher code to scripts partial file + Add author's MIT license to featherlight javascript * Remove unused bootstrap plugin * Bump LastModified plugin * Changed the path from 'lastmodified' to 'last-modified' for consistency * Cleanup README & Contribution guide * Changes to last pr * Fix GetCategoryAsync docs * Proofread and cleanup articles * Change passive voice in "Get Started" to active * Fix improper preposition in Commands Introduction page * Fix minor grammar mistakes in "Your First Bot" (future tense -> present tense/subjunctive mood -> indicative mood/proper noun casing/incorrect noun/add missing article) * Fix minor grammar mistakes in "Installation" (missing article) * no hablo ingles * Try try try again * I'm sure you're having as much fun as I am * Cleanup TOC & fix titles * Improve styling + Change title font to Noto Sans + Add materialized design for commit message box * Add DescriptionGenerator plugin * Add nightly section for clarification * Fix typos in Nightlies & Post-execution * Bump DescriptionGenerator to v1.1.0 + This build adds the functionality of generating managed references' summary into the description tag. * Initial emoji article draft * Add 'additional information' section for emoji article * Add cosmetic changes to the master css * Alter info box color + Add transition to article content * Add clarification in the emoji article * Emphasize that normal emoji string will not translate to its Unicode representation. * Clean up or add some of the samples featured in the article. + Add emoji/emote declaration section for clarification. + Add WebSocket emote sample. - Remove inconsistent styling ('wacky memes' proves to be too out of place). * Improve readability for nightlies article * Move 'Bundled Preconditions' section * Bump LastModified to fix UTC DateTime parsing * Add langwordMapping.yml * Add XML docs * Add VSC workspace rule * The root workspace limits the ruler to 120 characters for member documentations and excludes folders such as 'samples' and 'docs'. * The docs workspace limits the ruler to 70 characters for standard conceptual article to comply with documentation's CONTRIBUTING.md rule, and excludes temprorary folders created by DocFX. * Update CONTRIBUTING.md * Add documentation style rule * Fix styling of several member documentation * Fix ' />' caused by Agent Smith oddities * Fix styling to be more specific about the mention of IDs * Fix exception summary to comply with official Microsoft Docs style * References https://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.platformnotsupportedexception?view=netframework-4.7.2 https://docs.microsoft.com/en-us/dotnet/api/system.badimageformatexception?view=netframework-4.7.2 * Add XML documentations * Shift color return docs * Fix minor docs * Added documentation for SocketDMChannel, SocketGuildChannel, and SocketTextChannel * Add XML docs * Corrections to SocketGuildChannel * Corrections to SocketTextChannel * Corrections to SocketDMChannel * Swapped out 'id' for 'snowflake identifier * Swapped out 'id' for 'snowflake identifier' * SocketDMChannel amendments * SocketGuildChannel amendments * SocketTextChannel amendments * Add XML docs & patch return types + Starting from this commit, all return types for tasks will use style similar to most documentations featured on docs.microsoft.com References: https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.-ctor?view=efcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.filestream.readasync?view=netcore-2.1 https://docs.microsoft.com/en-us/dotnet/api/system.io.textwriter.writelineasync?view=netcore-2.1#System_IO_TextWriter_WriteLineAsync_System_Char___ And many more other asynchronous method documentations featured in the latest BCL. * Added documentation for many audit log data types, fixed vowel indefinite articles * Change audit log data types to start with 'Contains' (verb) instead of an article * Fix some documentation issues and document some more audit log data types * Fix English posession * Add XML doc * Documented two more types * Documented RoleCreateAuditLogData * Document remaining audit log data types * Added RestDMChannel documentation * Added RestGuildChannel documentation * Added RestTextChannel documentation * Added RestVoiceChannel documentation * Added RestUser documentation * Added RestRole documentation * Added RestMessage documentation * Slightly better wording * Contains -> Contains a piece of (describe article) * [EN] Present perf. -> past perf. * Add XML docs * Fix arrow alignment * Clarify supported nullable type * Fixed a typo in ISnowflakeEntity * Added RestUser Documentation * Added RestInvite documentation * Add XML docs & minor optimizations * Minor optimization for doc rendering * Rollback font optimization changes * Amendments to RestUser * Added SocketDMChannel documentation * Added RestDMChannel documentation * Added RestGuild documentation * Adjustment to SocketDMChannel * Added minimal descriptions from the API documentation for Integration types * Added obsolete mention to the ReadMessages flag. * Added remarks about 2FA requirement for guild permissions * Added xmldoc for GuildPermission methods * Added xml doc for ToAllowList and ToDenyList * Added specification of how the bits of the color raw value are packed * Added discord API documentation to IConnection interface * I can spell :^) * Fix whitespace in ChannelPermission * fix spacing of values in guildpermission * Made changes to get field descriptions from feedback, added returns tag to IConnection * Added property get standard for IntegrationAccount * Added property get pattern to xml docs and identical returns tag. * Change all color class references to struct ...because it isn't a class. * Add XML docs * Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about. * Rewrote the rest of the returns tags * Amendments * Cleanup doc for c1d78189 * Added types to <returns> tags where missing * Added second sample for adding reactions * Added some class summaries * Missed a period * Amendments * restored the removed line break * Removed unnecessary see tag * Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform * Add <remarks> tag to the IGuildIntegration xmldocs * Fix grammar issue * Update DescriptionGenerator * Cleanup of https://github.com/Still34/Discord.Net/pull/8 * Cleanup previous PR * Fix for misleading behaviour in the emoji guide + Original lines stated that sending a emoji wrapped in colon will not be parsed, but that was incorrect; replaced with reactions instead of sending messages as the example * Add strings for dictionary in DotSettings * Add XML docs * Fix lots of typos in comments + Geez, I didn't know there were so many. * Add XML docs & rewrite GetMessagesAsync docs This commit rewrites the remarks section of GetMessagesAsync, as well as adding examples to several methods. * Update 'Your First Bot' + This commit reflects the new changes made to the Discord Application Developer Portal after its major update * Initial optimization for DocFX render & add missing files * Add examples in message methods * Cleanup https://github.com/RogueException/Discord.Net/pull/1128 * Fix first bot note * Cleanup FAQ structure * Add XML docs * Update docfx plugins * Fix navbar collapsing issue * Fix broken xref * Cleanup FAQ section + Add introductory paragraphs to each FAQ section. + Add 'missing dependency' entry to commands FAQ. * Split commands FAQ to 'General' and 'DI' sections. * Cleanup https://github.com/RogueException/Discord.Net/pull/1139 * Fix missing namespace * Add missing highlighting css for the light theme * Add additional clarification for installing packages * Add indentation to example for clarity * Cleanup several articles to be more human-friendly and easier to read * Remove RPC-related notes * Cleanup slow-mode-related documentation strings * Add an additional note about cross-guild emote usage * Add CreateTextChannel sample * Add XMLDocs
2018-10-01 05:44:33 +08:00
parent 6b21b11f7d
commit ff0fea98a6
498 changed files with 16064 additions and 2633 deletions
--- a/docs/guides/commands/samples/command_handler.cs
+++ b/docs/guides/commands/samples/command_handler.cs
@@ -1,63 +0,0 @@
-using System;
-using System.Threading.Tasks;
-using System.Reflection;
-using Discord;
-using Discord.WebSocket;
-using Discord.Commands;
-using Microsoft.Extensions.DependencyInjection;
-
-public class Program
-{
-    private CommandService _commands;
-    private DiscordSocketClient _client;
-    private IServiceProvider _services;
-
-    private static void Main(string[] args) => new Program().StartAsync().GetAwaiter().GetResult();
-
-    public async Task StartAsync()
-    {
-        _client = new DiscordSocketClient();
-        _commands = new CommandService();
-
-        // Avoid hard coding your token. Use an external source instead in your code.
-        string token = "bot token here";
-
-        _services = new ServiceCollection()
-            .AddSingleton(_client)
-            .AddSingleton(_commands)
-            .BuildServiceProvider();
-
-        await InstallCommandsAsync();
-
-        await _client.LoginAsync(TokenType.Bot, token);
-        await _client.StartAsync();
-
-        await Task.Delay(-1);
-    }
-
-    public async Task InstallCommandsAsync()
-    {
-        // Hook the MessageReceived Event into our Command Handler
-        _client.MessageReceived += HandleCommandAsync;
-        // Discover all of the commands in this assembly and load them.
-        await _commands.AddModulesAsync(Assembly.GetEntryAssembly());
-    }
-
-    private async Task HandleCommandAsync(SocketMessage messageParam)
-    {
-        // Don't process the command if it was a System Message
-        var message = messageParam as SocketUserMessage;
-        if (message == null) return;
-        // Create a number to track where the prefix ends and the command begins
-        int argPos = 0;
-        // Determine if the message is a command, based on if it starts with '!' or a mention prefix
-        if (!(message.HasCharPrefix('!', ref argPos) || message.HasMentionPrefix(_client.CurrentUser, ref argPos))) return;
-        // Create a Command Context
-        var context = new SocketCommandContext(_client, message);
-        // Execute the command. (result does not indicate a return value, 
-        // rather an object stating if the command executed successfully)
-        var result = await _commands.ExecuteAsync(context, argPos, _services);
-        if (!result.IsSuccess)
-            await context.Channel.SendMessageAsync(result.ErrorReason);
-    }
-}
--- a/docs/guides/commands/samples/dependency-injection/dependency_map_setup.cs
+++ b/docs/guides/commands/samples/dependency-injection/dependency_map_setup.cs
@@ -0,0 +1,62 @@
+public class Initialize
+{
+	private readonly CommandService _commands;
+	private readonly DiscordSocketClient _client;
+
+	public Initialize(CommandService commands = null, DiscordSocketClient client = null)
+	{
+		_commands = commands ?? new CommandService();
+		_client = client ?? new DiscordSocketClient();
+	}
+
+	public IServiceProvider BuildServiceProvider() => new ServiceCollection()
+		.AddSingleton(_client)
+		.AddSingleton(_commands)
+		// You can pass in an instance of the desired type
+		.AddSingleton(new NotificationService())
+		// ...or by using the generic method.
+		//
+		// The benefit of using the generic method is that 
+		// ASP.NET DI will attempt to inject the required
+		// dependencies that are specified under the constructor 
+		// for us.
+		.AddSingleton<DatabaseService>()
+		.AddSingleton<CommandHandler>()
+		.BuildServiceProvider();
+}
+public class CommandHandler
+{
+	private readonly DiscordSocketClient _client;
+	private readonly CommandService _commands;
+	private readonly IServiceProvider _services;
+
+	public CommandHandler(IServiceProvider services, CommandService commands, DiscordSocketClient client)
+	{
+		_commands = commands;
+		_services = services;
+		_client = client;
+	}
+
+	public async Task InitializeAsync()
+	{
+		// Pass the service provider to the second parameter of
+		// AddModulesAsync to inject dependencies to all modules 
+		// that may require them.
+		await _commands.AddModulesAsync(
+			assembly: Assembly.GetEntryAssembly(), 
+			services: _services);
+		_client.MessageReceived += HandleCommandAsync;
+	}
+
+	public async Task HandleCommandAsync(SocketMessage msg)
+	{
+		// ...
+		// Pass the service provider to the ExecuteAsync method for
+		// precondition checks.
+		await _commands.ExecuteAsync(
+			context: context, 
+			argPos: argPos, 
+			services: _services);
+		// ...
+	}
+}
--- a/docs/guides/commands/samples/dependency-injection/dependency_module.cs
+++ b/docs/guides/commands/samples/dependency-injection/dependency_module.cs
@@ -0,0 +1,37 @@
+// After setting up dependency injection, modules will need to request
+// the dependencies to let the library know to pass 
+// them along during execution.
+
+// Dependency can be injected in two ways with Discord.Net.
+// You may inject any required dependencies via...
+// the module constructor
+// -or-
+// public settable properties
+
+// Injection via constructor
+public class DatabaseModule : ModuleBase<SocketCommandContext>
+{
+    private readonly DatabaseService _database;
+    public DatabaseModule(DatabaseService database)
+    {
+        _database = database;
+    }
+
+    [Command("read")]
+    public async Task ReadFromDbAsync()
+    {
+        await ReplyAsync(_database.GetData());
+    }
+}
+
+// Injection via public settable properties
+public class DatabaseModule : ModuleBase<SocketCommandContext>
+{
+    public DatabaseService DbService { get; set; }
+
+    [Command("read")]
+    public async Task ReadFromDbAsync()
+    {
+        await ReplyAsync(_database.GetData());
+    }
+}
--- a/docs/guides/commands/samples/dependency-injection/dependency_module_noinject.cs
+++ b/docs/guides/commands/samples/dependency-injection/dependency_module_noinject.cs
@@ -0,0 +1,29 @@
+// Sometimes injecting dependencies automatically with the provided
+// methods in the prior example may not be desired.
+
+// You may explicitly tell Discord.Net to **not** inject the properties
+// by either...
+// restricting the access modifier
+// -or-
+// applying DontInjectAttribute to the property
+
+// Restricting the access modifier of the property
+public class ImageModule : ModuleBase<SocketCommandContext>
+{
+    public ImageService ImageService { get; }
+    public ImageModule()
+    {
+        ImageService = new ImageService();
+    }
+}
+
+// Applying DontInjectAttribute
+public class ImageModule : ModuleBase<SocketCommandContext>
+{
+    [DontInject]
+    public ImageService ImageService { get; set; }
+    public ImageModule()
+    {
+        ImageService = new ImageService();
+    }
+}
--- a/docs/guides/commands/samples/dependency_map_setup.cs
+++ b/docs/guides/commands/samples/dependency_map_setup.cs
@@ -1,18 +0,0 @@
-private IServiceProvider _services;
-private CommandService _commands;
-
-public async Task InstallAsync(DiscordSocketClient client)
-{
-	// Here, we will inject the ServiceProvider with 
-	// all of the services our client will use.
-	_services = new ServiceCollection()
-		.AddSingleton(client)
-		.AddSingleton(_commands)
-		// You can pass in an instance of the desired type
-		.AddSingleton(new NotificationService())
-		// ...or by using the generic method.
-		.AddSingleton<DatabaseService>()
-		.BuildServiceProvider();
-	// ...
-	await _commands.AddModulesAsync(Assembly.GetEntryAssembly());
-}
--- a/docs/guides/commands/samples/dependency_module.cs
+++ b/docs/guides/commands/samples/dependency_module.cs
@@ -1,40 +0,0 @@
-using Discord;
-using Discord.Commands;
-using Discord.WebSocket;
-
-public class ModuleA : ModuleBase
-{
-    private readonly DatabaseService _database;
-
-    // Dependencies can be injected via the constructor
-    public ModuleA(DatabaseService database)
-    {
-        _database = database;
-    }
-
-    public async Task ReadFromDb()
-    {
-        var x = _database.getX();
-        await ReplyAsync(x);
-    }
-}
-
-public class ModuleB
-{
-
-    // Public settable properties will be injected
-    public AnnounceService { get; set; }
-
-    // Public properties without setters will not
-    public CommandService Commands { get; }
-
-    // Public properties annotated with [DontInject] will not
-    [DontInject]
-    public NotificationService { get; set; }
-
-    public ModuleB(CommandService commands)
-    {
-        Commands = commands;
-    }
-
-}
--- a/docs/guides/commands/samples/empty-module.cs
+++ b/docs/guides/commands/samples/empty-module.cs
@@ -1,6 +0,0 @@
-using Discord.Commands;
-
-public class InfoModule : ModuleBase<SocketCommandContext>
-{
-    
-}
--- a/docs/guides/commands/samples/intro/command_handler.cs
+++ b/docs/guides/commands/samples/intro/command_handler.cs
@@ -0,0 +1,63 @@
+public class CommandHandler
+{
+    private readonly DiscordSocketClient _client;
+    private readonly CommandService _commands;
+
+    public CommandHandler(DiscordSocketClient client, CommandService commands)
+    {
+        _commands = commands;
+        _client = client;
+    }
+    
+    public async Task InstallCommandsAsync()
+    {
+        // Hook the MessageReceived event into our command handler
+        _client.MessageReceived += HandleCommandAsync;
+
+        // Here we discover all of the command modules in the entry 
+        // assembly and load them. Starting from Discord.NET 2.0, a
+        // service provider is required to be passed into the
+        // module registration method to inject the 
+        // required dependencies.
+        //
+        // If you do not use Dependency Injection, pass null.
+        // See Dependency Injection guide for more information.
+        await _commands.AddModulesAsync(assembly: Assembly.GetEntryAssembly(), 
+                                        services: null);
+    }
+
+    private async Task HandleCommandAsync(SocketMessage messageParam)
+    {
+        // Don't process the command if it was a system message
+        var message = messageParam as SocketUserMessage;
+        if (message == null) return;
+
+        // Create a number to track where the prefix ends and the command begins
+        int argPos = 0;
+
+        // Determine if the message is a command based on the prefix
+        if (!(message.HasCharPrefix('!', ref argPos) || 
+            message.HasMentionPrefix(_client.CurrentUser, ref argPos)))
+            return;
+
+        // Create a WebSocket-based command context based on the message
+        var context = new SocketCommandContext(_client, message);
+
+        // Execute the command with the command context we just
+        // created, along with the service provider for precondition checks.
+        
+        // Keep in mind that result does not indicate a return value
+        // rather an object stating if the command executed successfully.
+        var result = await _command.ExecuteAsync(
+            context: context, 
+            argPos: argPos,
+            services: null);
+
+        // Optionally, we may inform the user if the command fails
+        // to be executed; however, this may not always be desired,
+        // as it may clog up the request queue should a user spam a
+        // command.
+        // if (!result.IsSuccess)
+        // await context.Channel.SendMessageAsync(result.ErrorReason);
+    }
+}
--- a/docs/guides/commands/samples/intro/empty-module.cs
+++ b/docs/guides/commands/samples/intro/empty-module.cs
@@ -0,0 +1,8 @@
+using Discord.Commands;
+
+// Keep in mind your module **must** be public and inherit ModuleBase.
+// If it isn't, it will not be discovered by AddModulesAsync!
+public class InfoModule : ModuleBase<SocketCommandContext>
+{
+    
+}
--- a/docs/guides/commands/samples/intro/groups.cs
+++ b/docs/guides/commands/samples/intro/groups.cs
@@ -4,15 +4,22 @@ public class AdminModule : ModuleBase<SocketCommandContext>
    [Group("clean")]
    public class CleanModule : ModuleBase<SocketCommandContext>
    {
-        // ~admin clean 15
+        // ~admin clean
        [Command]
-        public async Task Default(int count = 10) => Messages(count);
+        public async Task DefaultCleanAsync()
+        {
+            // ...
+        }

        // ~admin clean messages 15
        [Command("messages")]
-        public async Task Messages(int count = 10) { }
+        public async Task CleanAsync(int count)
+        {
+            // ...
+        }
    }
    // ~admin ban foxbot#0282
    [Command("ban")]
-    public async Task Ban(IGuildUser user) { }
+    public Task BanAsync(IGuildUser user) => 
+        Context.Guild.AddBanAsync(user);
 }
--- a/docs/guides/commands/samples/intro/module.cs
+++ b/docs/guides/commands/samples/intro/module.cs
@@ -1,24 +1,25 @@
 // Create a module with no prefix
-public class Info : ModuleBase<SocketCommandContext>
+public class InfoModule : ModuleBase<SocketCommandContext>
 {
-	// ~say hello -> hello
+	// ~say hello world -> hello world
 	[Command("say")]
 	[Summary("Echoes a message.")]
-	public async Task SayAsync([Remainder] [Summary("The text to echo")] string echo)
-	{
-		// ReplyAsync is a method on ModuleBase
-		await ReplyAsync(echo);
-	}
+	public Task SayAsync([Remainder] [Summary("The text to echo")] string echo)
+		=> ReplyAsync(echo);
+		
+	// ReplyAsync is a method on ModuleBase 
 }

 // Create a module with the 'sample' prefix
 [Group("sample")]
-public class Sample : ModuleBase<SocketCommandContext>
+public class SampleModule : ModuleBase<SocketCommandContext>
 {
 	// ~sample square 20 -> 400
 	[Command("square")]
 	[Summary("Squares a number.")]
-	public async Task SquareAsync([Summary("The number to square.")] int num)
+	public async Task SquareAsync(
+		[Summary("The number to square.")] 
+		int num)
 	{
 		// We can also access the channel from the Command Context.
 		await Context.Channel.SendMessageAsync($"{num}^2 = {Math.Pow(num, 2)}");
@@ -31,9 +32,12 @@ public class Sample : ModuleBase<SocketCommandContext>
 	// ~sample userinfo 96642168176807936 --> Khionu#8708
 	// ~sample whois 96642168176807936 --> Khionu#8708
 	[Command("userinfo")]
-	[Summary("Returns info about the current user, or the user parameter, if one passed.")]
+	[Summary
+	("Returns info about the current user, or the user parameter, if one passed.")]
 	[Alias("user", "whois")]
-	public async Task UserInfoAsync([Summary("The (optional) user to get info for")] SocketUser user = null)
+	public async Task UserInfoAsync(
+		[Summary("The (optional) user to get info from")]
+		SocketUser user = null)
 	{
 		var userInfo = user ?? Context.Client.CurrentUser;
 		await ReplyAsync($"{userInfo.Username}#{userInfo.Discriminator}");
--- a/docs/guides/commands/samples/post-execution/command_exception_log.cs
+++ b/docs/guides/commands/samples/post-execution/command_exception_log.cs
@@ -0,0 +1,13 @@
+public async Task LogAsync(LogMessage logMessage)
+{
+    // This casting type requries C#7
+    if (logMessage.Exception is CommandException cmdException)
+    {
+        // We can tell the user that something unexpected has happened
+        await cmdException.Context.Channel.SendMessageAsync("Something went catastrophically wrong!");
+
+        // We can also log this incident
+        Console.WriteLine($"{cmdException.Context.User} failed to execute '{cmdException.Command.Name}' in {cmdException.Context.Channel}.");
+        Console.WriteLine(cmdException.ToString());
+    }
+}
--- a/docs/guides/commands/samples/post-execution/command_executed_adv_demo.cs
+++ b/docs/guides/commands/samples/post-execution/command_executed_adv_demo.cs
@@ -0,0 +1,13 @@
+public async Task OnCommandExecutedAsync(CommandInfo command, ICommandContext context, IResult result)
+{
+    switch(result)
+    {
+        case MyCustomResult customResult:
+            // do something extra with it
+            break;
+        default:
+            if (!string.IsNullOrEmpty(result.ErrorReason))
+                await context.Channel.SendMessageAsync(result.ErrorReason);
+            break;
+    }
+}
--- a/docs/guides/commands/samples/post-execution/command_executed_demo.cs
+++ b/docs/guides/commands/samples/post-execution/command_executed_demo.cs
@@ -0,0 +1,38 @@
+public async Task SetupAsync()
+{
+    await _command.AddModulesAsync(Assembly.GetEntryAssembly(), _services);
+    // Hook the execution event
+    _command.CommandExecuted += OnCommandExecutedAsync;
+    // Hook the command handler
+    _client.MessageReceived += HandleCommandAsync;
+}
+public async Task OnCommandExecutedAsync(CommandInfo command, ICommandContext context, IResult result)
+{
+    // We have access to the information of the command executed,
+    // the context of the command, and the result returned from the
+    // execution in this event.
+
+    // We can tell the user what went wrong
+    if (!string.IsNullOrEmpty(result?.ErrorReason))
+    {
+        await context.Channel.SendMessageAsync(result.ErrorReason);
+    }
+
+    // ...or even log the result (the method used should fit into
+    // your existing log handler)
+    await _log.LogAsync(new LogMessage(LogSeverity.Info, "CommandExecution", $"{command?.Name} was executed at {DateTime.UtcNow}."));
+}
+public async Task HandleCommandAsync(SocketMessage msg)
+{
+    var message = messageParam as SocketUserMessage;
+    if (message == null) return;
+    int argPos = 0;
+    if (!(message.HasCharPrefix('!', ref argPos) || message.HasMentionPrefix(_client.CurrentUser, ref argPos))) return;
+    var context = new SocketCommandContext(_client, message);
+    var result = await _commands.ExecuteAsync(context, argPos, _services);
+    // Optionally, you may pass the result manually into your
+    // CommandExecuted event handler if you wish to handle parsing or
+    // precondition failures in the same method.
+
+    // await OnCommandExecutedAsync(null, context, result);
+}
--- a/docs/guides/commands/samples/post-execution/customresult_base.cs
+++ b/docs/guides/commands/samples/post-execution/customresult_base.cs
@@ -0,0 +1,6 @@
+public class MyCustomResult : RuntimeResult
+{
+    public MyCustomResult(CommandError? error, string reason) : base(error, reason)
+    {
+    }
+}
--- a/docs/guides/commands/samples/post-execution/customresult_extended.cs
+++ b/docs/guides/commands/samples/post-execution/customresult_extended.cs
@@ -0,0 +1,10 @@
+public class MyCustomResult : RuntimeResult
+{
+    public MyCustomResult(CommandError? error, string reason) : base(error, reason)
+    {
+    }
+    public static MyCustomResult FromError(string reason) =>
+        new MyCustomResult(CommandError.Unsuccessful, reason);
+    public static MyCustomResult FromSuccess(string reason = null) =>
+        new MyCustomResult(null, reason);
+}
--- a/docs/guides/commands/samples/post-execution/customresult_usage.cs
+++ b/docs/guides/commands/samples/post-execution/customresult_usage.cs
@@ -0,0 +1,10 @@
+public class MyModule : ModuleBase<SocketCommandContext>
+{
+    [Command("eat")]
+    public async Task<RuntimeResult> ChooseAsync(string food)
+    {
+        if (food == "salad")
+            return MyCustomResult.FromError("No, I don't want that!");
+        return MyCustomResult.FromSuccess($"Give me the {food}!").
+    }
+}
--- a/docs/guides/commands/samples/post-execution/post-execution_basic.cs
+++ b/docs/guides/commands/samples/post-execution/post-execution_basic.cs
@@ -0,0 +1,11 @@
+var result = await _commands.ExecuteAsync(context, argPos, _services);
+if (result.CommandError != null)
+	switch(result.CommandError)
+	{
+		case CommandError.BadArgCount:
+			await context.Channel.SendMessageAsync("Parameter count does not match any command's.");
+			break;
+		default:
+			await context.Channel.SendMessageAsync($"An error has occurred {result.ErrorReason}");
+			break;
+	}
--- a/docs/guides/commands/samples/preconditions/group_precondition.cs
+++ b/docs/guides/commands/samples/preconditions/group_precondition.cs
@@ -0,0 +1,9 @@
+// The following example only requires the user to either have the
+// Administrator permission in this guild or own the bot application.
+[RequireUserPermission(GuildPermission.Administrator, Group = "Permission")]
+[RequireOwner(Group = "Permission")]
+public class AdminModule : ModuleBase<SocketCommandContext>
+{
+    [Command("ban")]
+    public Task BanAsync(IUser user) => Context.Guild.AddBanAsync(user);
+}
--- a/docs/guides/commands/samples/preconditions/precondition_usage.cs
+++ b/docs/guides/commands/samples/preconditions/precondition_usage.cs
@@ -0,0 +1,3 @@
+[RequireOwner]
+[Command("echo")]
+public Task EchoAsync(string input) => ReplyAsync(input);
--- a/docs/guides/commands/samples/preconditions/require_owner.cs
+++ b/docs/guides/commands/samples/preconditions/require_owner.cs
@@ -1,4 +1,5 @@
-// (Note: This precondition is obsolete, it is recommended to use the RequireOwnerAttribute that is bundled with Discord.Commands)
+// (Note: This precondition is obsolete, it is recommended to use the
+// RequireOwnerAttribute that is bundled with Discord.Commands)

 using Discord.Commands;
 using Discord.WebSocket;
@@ -10,10 +11,13 @@ using System.Threading.Tasks;
 public class RequireOwnerAttribute : PreconditionAttribute
 {
    // Override the CheckPermissions method
-    public async override Task<PreconditionResult> CheckPermissions(ICommandContext context, CommandInfo command, IServiceProvider services)
+    public async override Task<PreconditionResult> CheckPermissionsAsync(ICommandContext context, CommandInfo command, IServiceProvider services)
    {
+        // Get the client via Depedency Injection
+        var client = services.GetRequiredService<DiscordSocketClient>();
        // Get the ID of the bot's owner
-        var ownerId = (await services.GetService<DiscordSocketClient>().GetApplicationInfoAsync()).Owner.Id;
+        var appInfo = await client.GetApplicationInfoAsync().ConfigureAwait(false);
+        var ownerId = appInfo.Owner.Id;
        // If this command was executed by that user, return a success
        if (context.User.Id == ownerId)
            return PreconditionResult.FromSuccess();
--- a/docs/guides/commands/samples/typereaders/typereader-register.cs
+++ b/docs/guides/commands/samples/typereaders/typereader-register.cs
@@ -0,0 +1,29 @@
+public class CommandHandler
+{
+    private readonly CommandService _commands;
+    private readonly DiscordSocketClient _client;
+    private readonly IServiceProvider _services;
+
+    public CommandHandler(CommandService commands, DiscordSocketClient client, IServiceProvider services)
+    {
+        _commands = commands;
+        _client = client;
+        _services = services;
+    }
+
+    public async Task SetupAsync()
+    {
+        _client.MessageReceived += CommandHandleAsync;
+
+        // Add BooleanTypeReader to type read for the type "bool"
+        _commands.AddTypeReader(typeof(bool), new BooleanTypeReader());
+
+        // Then register the modules
+        await _commands.AddModulesAsync(Assembly.GetEntryAssembly(), _services);
+    }
+
+    public async Task CommandHandleAsync(SocketMessage msg)
+    {
+        // ...
+    }
+}
--- a/docs/guides/commands/samples/typereaders/typereader.cs
+++ b/docs/guides/commands/samples/typereaders/typereader.cs
@@ -1,10 +1,11 @@
-// Note: This example is obsolete, a boolean type reader is bundled with Discord.Commands
+// Note: This example is obsolete, a boolean type reader is bundled 
+// with Discord.Commands
 using Discord;
 using Discord.Commands;

 public class BooleanTypeReader : TypeReader
 {
-    public override Task<TypeReaderResult> Read(ICommandContext context, string input, IServiceProvider services)
+    public override Task<TypeReaderResult> ReadAsync(ICommandContext context, string input, IServiceProvider services)
    {
        bool result;
        if (bool.TryParse(input, out result))