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

docs: Fix MaxWaitBetweenGuildAvailablesBeforeReady docs string

Browse Source 
Signed-off-by: Still Hsu <dev@stillu.cc>
This commit is contained in:
Still Hsu
2020-12-14 12:07:24 +08:00
parent 4988a0764d
commit e31cdc7586
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/Discord.Net.WebSocket/DiscordSocketConfig.cs
View File

@@ -138,16 +138,17 @@ namespace Discord.WebSocket
/// </remarks>
public int IdentifyMaxConcurrency { get; set; } = 1;
/// <summary>
/// Gets or sets the maximum wait time in milliseconds between GUILD_AVAILABLE events before firing READY.
///
/// If zero, READY will fire as soon as it is received and all guilds will be unavailable.
/// </summary>
/// <remarks>
/// <para>This property is measured in milliseconds, negative values will throw an exception.</para>
/// <para>This property is measured in milliseconds; negative values will throw an exception.</para>
/// <para>If a guild is not received before READY, it will be unavailable.</para>
/// </remarks>
/// <returns>
/// The maximum wait time in milliseconds between GUILD_AVAILABLE events before firing READY.
/// A <see cref="int"/> representing the maximum wait time in milliseconds between GUILD_AVAILABLE events
/// before firing READY.
/// </returns>
/// <exception cref="System.ArgumentException">Value must be at least 0.</exception>
public int MaxWaitBetweenGuildAvailablesBeforeReady {