github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs compile issue

Browse Source
This commit is contained in:
Christopher F
2017-05-21 14:55:47 -04:00
parent 588df7b0c7
commit 3fb661a33a
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/migrating/migrating.md
View File

@@ -42,7 +42,7 @@ events are delegates, but are still registered the same.
For example, let's look at [DiscordSocketClient.MessageReceived](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_MessageReceived) For example, let's look at [DiscordSocketClient.MessageReceived](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_MessageReceived)
To hook an event into MessageReceived, we now use the following code: To hook an event into MessageReceived, we now use the following code:
[!code-csharp[Event Registration](guides/samples/migrating/event.cs)] [!code-csharp[Event Registration](samples/event.cs)]
> **All Event Handlers in 1.0 MUST return Task!** > **All Event Handlers in 1.0 MUST return Task!**
@@ -50,7 +50,7 @@ If your event handler is marked as `async`, it will automatically return `Task`.
if you do not need to execute asynchronus code, do _not_ mark your handler as `async`, and instead, if you do not need to execute asynchronus code, do _not_ mark your handler as `async`, and instead,
stick a `return Task.CompletedTask` at the bottom. stick a `return Task.CompletedTask` at the bottom.
[!code-csharp[Sync Event Registration](guides/samples/migrating/sync_event.cs)] [!code-csharp[Sync Event Registration](samples/sync_event.cs)]
**Event handlers no longer require a sender.** The only arguments your event handler needs to accept **Event handlers no longer require a sender.** The only arguments your event handler needs to accept
are the parameters used by the event. It is recommended to look at the event in IntelliSense or on the are the parameters used by the event. It is recommended to look at the event in IntelliSense or on the