Add DiscordShardedClient sample project & Client FAQ entry. #1177
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Still34
requested changes
Oct 19, 2018
docs/faq/basics/client-basics.md
Outdated
| instances, with each one serving a different amount of guilds. | ||
|
|
||
| Aside from a few noteworthy differences in some event names, and specifying the amount of shards to connect with |
There was a problem hiding this comment.
Run-on sentence; revision is recommended.
| The main differences are: | ||
| 1. You need to specify the total amount of shards, or shard ids, via [DiscordShardedClient]'s constructors. | ||
| 2. The [Connected], [Disconnected], [Ready], and [LatencyUpdated] events |
There was a problem hiding this comment.
All [] references are not linked correctly. Add corresponding xrefs at the bottom of the section.
e.g.,
2. The [Connected], [Disconnected], [Ready], and [LatencyUpdated] events
...
[Connected]: xref:Discord.WebSocket.DiscordSocketClient.ConnectedCurrent Snapshot
docs/faq/basics/client-basics.md
Outdated
|
|
||
| Aside from a few noteworthy differences in some event names, and specifying the amount of shards to connect with | ||
| in a [DiscordSocketConfig], there are very few differences from the [DiscordSocketClient] class, and it is very straightforward |
There was a problem hiding this comment.
Suggested change
| in a [DiscordSocketConfig], there are very few differences from the [DiscordSocketClient] class, and it is very straightforward | |
| within a [DiscordSocketConfig], there are very few differences from the [DiscordSocketClient] class, and it is very straightforward |
docs/faq/basics/client-basics.md
Outdated
| instances, with each one serving a different amount of guilds. | ||
|
|
||
| Aside from a few noteworthy differences in some event names, and specifying the amount of shards to connect with |
There was a problem hiding this comment.
Suggested change
| Aside from a few noteworthy differences in some event names, and specifying the amount of shards to connect with | |
| Aside from a few noteworthy differences in some event names, and specifying the number of shards to connect with |
docs/faq/basics/client-basics.md
Outdated
|
|
||
| If you do not wish to use the [DiscordShardedClient] and instead reuse the same [DiscordSocketClient] code and manually shard them, | ||
| you can do so by specifiying the [ShardId] for the [DiscordSocketConfig] and pass that to the [DiscordSocketClient]'s constructor. |
There was a problem hiding this comment.
Suggested change
| you can do so by specifiying the [ShardId] for the [DiscordSocketConfig] and pass that to the [DiscordSocketClient]'s constructor. | |
| you can do so by specifying the [ShardId] for the [DiscordSocketConfig] and pass that to the [DiscordSocketClient]'s constructor. |
samples/03_sharded_client/Program.cs
Outdated
| TotalShards = 2 | ||
| }; | ||
|
|
||
| var services = ConfigureServices(); |
There was a problem hiding this comment.
_client is uninitiated at this point?
| _discord = services.GetRequiredService<DiscordShardedClient>(); | ||
| _services = services; | ||
|
|
||
| _discord.MessageReceived += MessageReceivedAsync; |
There was a problem hiding this comment.
I'd probably move it under InitializeAsync so it doesn't start processing before modules are discovered.
There was a problem hiding this comment.
"It" just being the handler attachment?
foxbot
approved these changes
Oct 20, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1118 .