From 936cccf9bcb86f3d918d00dbceb031bc2965d21a Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Wed, 12 Sep 2018 17:11:42 +0800 Subject: [PATCH] Cleanup slow-mode-related documentation strings --- .../Entities/Channels/ITextChannel.cs | 8 +++++++- .../Entities/Channels/TextChannelProperties.cs | 11 ++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs index 6c5d65501..440349eca 100644 --- a/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs +++ b/src/Discord.Net.Core/Entities/Channels/ITextChannel.cs @@ -26,7 +26,13 @@ namespace Discord /// string Topic { get; } - /// Gets the current slow-mode delay for this channel. 0 if disabled. + /// + /// Gets the current slow-mode delay for this channel. + /// + /// + /// An representing the time in seconds required before the user can send another + /// message; 0 if disabled. + /// int SlowModeInterval { get; } /// diff --git a/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs b/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs index 883493176..fbe4bfa43 100644 --- a/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs +++ b/src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs @@ -15,14 +15,15 @@ namespace Discord /// public Optional IsNsfw { get; set; } /// - /// What the slow-mode ratelimit for this channel should be set to; 0 will disable slow-mode. + /// Gets or sets the slow-mode ratelimit in seconds for this channel. /// /// - /// This value must fall within [0, 120] - /// - /// Users with will be exempt from slow-mode. + /// Setting this value to 0 will disable slow-mode for this channel. + /// + /// Users with will be exempt from slow-mode. + /// /// - /// Throws ArgummentOutOfRange if the value does not fall within [0, 120] + /// Thrown if the value does not fall within [0, 120]. public Optional SlowModeInterval { get; set; } } }