From 08d6558975f7aeb9a7d1e3169bca6e646a77ce42 Mon Sep 17 00:00:00 2001 From: Hsu Still <341464@gmail.com> Date: Sat, 31 Mar 2018 00:29:18 +0800 Subject: [PATCH] Tidy up docs --- ...xt.Overwrite.md => CommandContext.Inclusion.md} | 5 ----- .../Commands/CommandContext.Overwrite.md | 18 ++++++++++++---- .../Commands/ShardedCommandContext.Overwrite.md | 10 --------- .../Common/Discord.EmbedBuilder.Overwrites.md | 7 +++++- .../Common/Discord.EmbedObjectBuilder.Inclusion.md | 25 ++++++++++++++++++++++ .../Discord.EmbedObjectBuilder.Overwrites.md | 20 +++++++++++++++++ 6 files changed, 65 insertions(+), 20 deletions(-) rename docs/_overwrites/Commands/{SocketCommandContext.Overwrite.md => CommandContext.Inclusion.md} (72%) delete mode 100644 docs/_overwrites/Commands/ShardedCommandContext.Overwrite.md create mode 100644 docs/_overwrites/Common/Discord.EmbedObjectBuilder.Inclusion.md create mode 100644 docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md diff --git a/docs/_overwrites/Commands/SocketCommandContext.Overwrite.md b/docs/_overwrites/Commands/CommandContext.Inclusion.md similarity index 72% rename from docs/_overwrites/Commands/SocketCommandContext.Overwrite.md rename to docs/_overwrites/Commands/CommandContext.Inclusion.md index 192ad1682..c99148db7 100644 --- a/docs/_overwrites/Commands/SocketCommandContext.Overwrite.md +++ b/docs/_overwrites/Commands/CommandContext.Inclusion.md @@ -1,8 +1,3 @@ ---- -uid: Discord.Commands.SocketCommandContext -example: [*content] ---- - An example of how this class is used the command system can be seen below: diff --git a/docs/_overwrites/Commands/CommandContext.Overwrite.md b/docs/_overwrites/Commands/CommandContext.Overwrite.md index b94388324..2f8c0cd48 100644 --- a/docs/_overwrites/Commands/CommandContext.Overwrite.md +++ b/docs/_overwrites/Commands/CommandContext.Overwrite.md @@ -3,8 +3,18 @@ uid: Discord.Commands.CommandContext example: [*content] --- -An example of how this class is used the command system can be seen -below: +[!include[Example Section](CommandContext.Inclusion.md)] -[!code[Sample module](../../guides/commands/samples/empty-module.cs)] -[!code[Command handler](../../guides/commands/samples/command_handler.cs)] \ No newline at end of file +--- +uid: Discord.Commands.SocketCommandContext +example: [*content] +--- + +[!include[Example Section](CommandContext.Inclusion.md)] + +--- +uid: Discord.Commands.ShardCommandContext +example: [*content] +--- + +[!include[Example Section](CommandContext.Inclusion.md)] \ No newline at end of file diff --git a/docs/_overwrites/Commands/ShardedCommandContext.Overwrite.md b/docs/_overwrites/Commands/ShardedCommandContext.Overwrite.md deleted file mode 100644 index 0a97dc47b..000000000 --- a/docs/_overwrites/Commands/ShardedCommandContext.Overwrite.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -uid: Discord.Commands.ShardedCommandContext -example: [*content] ---- - -An example of how this class is used the command system can be seen -below: - -[!code[Sample module](../../guides/commands/samples/empty-module.cs)] -[!code[Command handler](../../guides/commands/samples/command_handler.cs)] \ No newline at end of file diff --git a/docs/_overwrites/Common/Discord.EmbedBuilder.Overwrites.md b/docs/_overwrites/Common/Discord.EmbedBuilder.Overwrites.md index 2a0de73d5..de7da8f5d 100644 --- a/docs/_overwrites/Common/Discord.EmbedBuilder.Overwrites.md +++ b/docs/_overwrites/Common/Discord.EmbedBuilder.Overwrites.md @@ -1,5 +1,9 @@ --- uid: Discord.EmbedBuilder +seealso: + - linkId: Discord.EmbedFooterBuilder + - linkId: Discord.EmbedAuthorBuilder + - linkId: Discord.EmbedFieldBuilder remarks: *content --- @@ -12,7 +16,8 @@ uid: Discord.EmbedBuilder example: [*content] --- -The example below builds an embed and sends it to the chat. +The example below builds an embed and sends it to the chat using the +command system. ```cs [Command("embed")] diff --git a/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Inclusion.md b/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Inclusion.md new file mode 100644 index 000000000..eac0d9ca5 --- /dev/null +++ b/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Inclusion.md @@ -0,0 +1,25 @@ +The example will build a rich embed with an author field, a footer +field, and 2 normal fields using an @Discord.EmbedBuilder: + +```cs +var exampleAuthor = new EmbedAuthorBuilder() + .WithName("I am a bot") + .WithIconUrl("https://discordapp.com/assets/e05ead6e6ebc08df9291738d0aa6986d.png"); +var exampleFooter = new EmbedFooterBuilder() + .WithText("I am a nice footer") + .WithIconUrl("https://discordapp.com/assets/28174a34e77bb5e5310ced9f95cb480b.png"); +var exampleField = new EmbedFieldBuilder() + .WithName("Title of Another Field") + .WithValue("I am an [example](https://example.com).") + .WithInline(true); +var otherField = new EmbedFieldBuilder() + .WithName("Title of a Field") + .WithValue("Notice how I'm inline with that other field next to me.") + .WithInline(true); +var embed = new EmbedBuilder() + .AddField(exampleField) + .AddField(otherField) + .WithAuthor(exampleAuthor) + .WithFooter(exampleFooter) + .Build(); +``` \ No newline at end of file diff --git a/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md b/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md new file mode 100644 index 000000000..85bf150b7 --- /dev/null +++ b/docs/_overwrites/Common/Discord.EmbedObjectBuilder.Overwrites.md @@ -0,0 +1,20 @@ +--- +uid: Discord.EmbedAuthorBuilder +example: [*content] +--- + +[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)] + +--- +uid: Discord.EmbedFooterBuilder +example: [*content] +--- + +[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)] + +--- +uid: Discord.EmbedFieldBuilder +example: [*content] +--- + +[!include[Embed Object Builder Sample](Discord.EmbedObjectBuilder.Inclusion.md)] \ No newline at end of file