Browse Source

docs: fix typos, clarify wording

pull/1319/head
Chris Johnston 6 years ago
parent
commit
146e0e41cb
4 changed files with 12 additions and 12 deletions
  1. +4
    -4
      src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs
  2. +5
    -5
      src/Discord.Net.Core/Entities/Guilds/IGuild.cs
  3. +2
    -2
      src/Discord.Net.Core/Entities/Guilds/SystemChannelMessageDeny.cs
  4. +1
    -1
      src/Discord.Net.Core/Extensions/GuildExtensions.cs

+ 4
- 4
src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs View File

@@ -71,17 +71,17 @@ namespace Discord
/// </summary>
public Optional<ExplicitContentFilterLevel> ExplicitContentFilter { get; set; }
/// <summary>
/// Gets or sets the flags that DISABLE types of system channels.
/// Gets or sets the flags that DISABLE types of system channel messages.
/// </summary>
/// <remarks>
/// These flags are inverted. Setting a flag will disable that system channel message from being sent.
/// A value of <see cref="SystemChannelMessageDeny.None"/> will allow all system channel message types to be sent,
/// given that the <see cref="SystemChannelId"/> has also been sent.
/// given that the <see cref="SystemChannelId"/> has also been set.
/// A value of <see cref="SystemChannelMessageDeny.GuildBoost"/> will deny guild boost messages from being sent, and allow all
/// other types of messages.
/// Refer to the extension methods <see cref="GuildExtensions.GetGuildBoostMessagesEnabled(IGuild)"/> and
/// <see cref="GuildExtensions.GetWelcomeMessagesEnabled(IGuild)"/> to check if these system channel messages
/// are enabled, without the need to manipulate the flags.
/// <see cref="GuildExtensions.GetWelcomeMessagesEnabled(IGuild)"/> to check if these system channel message types
/// are enabled, without the need to manipulate the logic of the flag.
/// </remarks>
public Optional<SystemChannelMessageDeny> SystemChannelFlags { get; set; }
}


+ 5
- 5
src/Discord.Net.Core/Entities/Guilds/IGuild.cs View File

@@ -213,9 +213,6 @@ namespace Discord
/// <summary>
/// Gets the URL of this guild's banner image.
/// </summary>
/// <remarks>
/// This is referred to as the vanity image in the API.
/// </remarks>
/// <returns>
/// A URL pointing to the guild's banner image; <c>null</c> if none is set.
/// </returns>
@@ -228,10 +225,10 @@ namespace Discord
/// </returns>
string VanityURLCode { get; }
/// <summary>
/// Gets the flags for the types of system channels that are disabled.
/// Gets the flags for the types of system channel messages that are disabled.
/// </summary>
/// <returns>
/// The flags for the types of system channel flags that are disabled.
/// The flags for the types of system channel messages that are disabled.
/// </returns>
SystemChannelMessageDeny SystemChannelFlags { get; }
/// <summary>
@@ -244,6 +241,9 @@ namespace Discord
/// <summary>
/// Gets the number of premium subscribers of this guild.
/// </summary>
/// <remarks>
/// This is the number of users who have boosted this guild.
/// </remarks>
/// <returns>
/// The number of premium subscribers of this guild.
/// </returns>


+ 2
- 2
src/Discord.Net.Core/Entities/Guilds/SystemChannelMessageDeny.cs View File

@@ -11,11 +11,11 @@ namespace Discord
/// </summary>
None = 0,
/// <summary>
/// The messages that are sent when a user joins the guild.
/// Deny the messages that are sent when a user joins the guild.
/// </summary>
WelcomeMessage = 0b1,
/// <summary>
/// The messages that are sent when a user boosts the guild.
/// Deny the messages that are sent when a user boosts the guild.
/// </summary>
GuildBoost = 0b10
}


+ 1
- 1
src/Discord.Net.Core/Extensions/GuildExtensions.cs View File

@@ -6,7 +6,7 @@ namespace Discord
public static class GuildExtensions
{
/// <summary>
/// Gets if welcome message system messages are enabled.
/// Gets if welcome system messages are enabled.
/// </summary>
/// <param name="guild"> The guild to check. </param>
/// <returns> A <c>bool</c> indicating if the welcome messages are enabled in the system channel. </returns>


Loading…
Cancel
Save