From 243e819b86ad7f911db920e39e9a3c38c09ad662 Mon Sep 17 00:00:00 2001 From: Hsu Still <341464@gmail.com> Date: Fri, 6 Apr 2018 23:54:09 +0800 Subject: [PATCH] Fix minor markdown issues --- docs/faq/misc/Legacy.md | 4 +++- docs/guides/concepts/events.md | 4 ++-- docs/guides/concepts/logging.md | 2 +- docs/guides/getting_started/installing.md | 6 +++--- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/faq/misc/Legacy.md b/docs/faq/misc/Legacy.md index 63656654e..c929a492b 100644 --- a/docs/faq/misc/Legacy.md +++ b/docs/faq/misc/Legacy.md @@ -5,7 +5,8 @@ title: Questions about Legacy Versions # Legacy Questions -## X, Y, Z does not work! It doesn't return a valid value anymore. +## X, Y, Z does not work! It doesn't return a valid value anymore + If you're currently using an older version in stable branch, please upgrade to the latest pre-release version to ensure maximum compatibility. Several features may be broken in older @@ -17,6 +18,7 @@ Visit the repo's [release tag] to see the latest public pre-release. [release tag]: https://github.com/RogueException/Discord.Net/releases ## I came from an earlier version of Discord.NET 1.0, and DependencyMap doesn't seem to exist anymore in the later revision? What happened to it? + The `DependencyMap` has been replaced with Microsoft's [DependencyInjection] Abstractions. An example usage can be seen [here](https://github.com/foxbot/DiscordBotBase/blob/csharp/src/DiscordBot/Program.cs#L36). diff --git a/docs/guides/concepts/events.md b/docs/guides/concepts/events.md index a6a65f439..d80e564ae 100644 --- a/docs/guides/concepts/events.md +++ b/docs/guides/concepts/events.md @@ -7,8 +7,8 @@ title: Working with Events Events in Discord.Net are consumed in a similar manner to the standard convention, with the exception that every event must be of the type -`System.Threading.Tasks.Task` and instead of using `EventArgs`, the -event's parameters are passed directly into the handler. +@System.Threading.Tasks.Task and instead of using @System.EventArgs, +the event's parameters are passed directly into the handler. This allows for events to be handled in an async context directly instead of relying on `async void`. diff --git a/docs/guides/concepts/logging.md b/docs/guides/concepts/logging.md index 21565c828..224fb1d42 100644 --- a/docs/guides/concepts/logging.md +++ b/docs/guides/concepts/logging.md @@ -33,7 +33,7 @@ to a logging function to write their own messages. ## Usage in Commands -Discord.Net's [CommandService] also provides a @Discord.Commands.CommandService.Log +Discord.Net's [CommandService] also provides a @Discord.Commands.CommandService.Log event, identical in signature to other log events. Data logged through this event is typically coupled with a diff --git a/docs/guides/getting_started/installing.md b/docs/guides/getting_started/installing.md index 7a039f35f..2a802776f 100644 --- a/docs/guides/getting_started/installing.md +++ b/docs/guides/getting_started/installing.md @@ -65,7 +65,7 @@ Not sure how to add a direct feed? See how [with Visual Studio] or 1. Create a new solution for your bot. 2. Open the NuGet window (Tools > NuGet > Manage NuGet packages for -Solution). + Solution). ![Step 2](images/install-rider-nuget-manager.png) 3. In the "Packages" tab, search for `Discord.Net`. ![Step 3](images/install-rider-search.png) @@ -102,7 +102,7 @@ Solution). In order to compile Discord.Net, you require the following: -### Using Visual Studio +## Using Visual Studio - [Visual Studio 2017](https://www.visualstudio.com/) - [.NET Core SDK] @@ -110,7 +110,7 @@ In order to compile Discord.Net, you require the following: The .NET Core and Docker (Preview) workload is required during Visual Studio installation. -### Using Command Line +## Using Command Line - [.NET Core SDK]