From 3a7d7ee9552a2c6fea1c32b6f3cd91f6efdd29f5 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Sat, 5 May 2018 15:36:22 +0800 Subject: [PATCH] Minor fixes in documentations + Fix unescaped '<' + Fix typo --- .../Commands/PreconditionAttribute.Overwrites.md | 4 ++-- src/Discord.Net.Core/Entities/Emotes/Emote.cs | 4 ++-- src/Discord.Net.Core/Entities/IMentionable.cs | 2 +- src/Discord.Net.Core/Entities/Users/IUser.cs | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md b/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md index 8117b2c3f..9af953e72 100644 --- a/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md +++ b/docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md @@ -31,11 +31,11 @@ The following example creates a precondition to see if the user has sufficient role required to access the command. ```cs -public class RequireRoleAtribute : PreconditionAttribute +public class RequireRoleAttribute : PreconditionAttribute { private readonly ulong _roleId; - public RequireRoleAtribute(ulong roleId) + public RequireRoleAttribute(ulong roleId) { _roleId = roleId; } diff --git a/src/Discord.Net.Core/Entities/Emotes/Emote.cs b/src/Discord.Net.Core/Entities/Emotes/Emote.cs index 68156016b..32d49fede 100644 --- a/src/Discord.Net.Core/Entities/Emotes/Emote.cs +++ b/src/Discord.Net.Core/Entities/Emotes/Emote.cs @@ -59,7 +59,7 @@ namespace Discord } /// Parses an from its raw format. - /// The raw encoding of an emote; for example, <:dab:277855270321782784>. + /// The raw encoding of an emote; for example, <:dab:277855270321782784>. /// An emote. /// Invalid emote format. public static Emote Parse(string text) @@ -70,7 +70,7 @@ namespace Discord } /// Tries to parse an from its raw format. - /// The raw encoding of an emote; for example, <:dab:277855270321782784>. + /// The raw encoding of an emote; for example, <:dab:277855270321782784>. /// An emote. public static bool TryParse(string text, out Emote result) { diff --git a/src/Discord.Net.Core/Entities/IMentionable.cs b/src/Discord.Net.Core/Entities/IMentionable.cs index cf4a8662b..225806723 100644 --- a/src/Discord.Net.Core/Entities/IMentionable.cs +++ b/src/Discord.Net.Core/Entities/IMentionable.cs @@ -9,7 +9,7 @@ namespace Discord /// Returns a special string used to mention this object. /// /// - /// A string that is recognized by Discord as a mention (e.g. <@168693960628371456>). + /// A string that is recognized by Discord as a mention (e.g. <@168693960628371456>). /// string Mention { get; } } diff --git a/src/Discord.Net.Core/Entities/Users/IUser.cs b/src/Discord.Net.Core/Entities/Users/IUser.cs index 929824ced..aabe4fdb4 100644 --- a/src/Discord.Net.Core/Entities/Users/IUser.cs +++ b/src/Discord.Net.Core/Entities/Users/IUser.cs @@ -12,7 +12,7 @@ namespace Discord /// string AvatarId { get; } /// - /// Gets the URL to this user's avatar. + /// Returns the URL to this user's avatar. /// /// The format to return. /// @@ -23,7 +23,7 @@ namespace Discord /// string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128); /// - /// Gets the URL to this user's default avatar. + /// Returns the URL to this user's default avatar. /// string GetDefaultAvatarUrl(); /// @@ -35,11 +35,11 @@ namespace Discord /// ushort DiscriminatorValue { get; } /// - /// Returns if this user is a bot user. + /// Gets if this user is a bot user. /// bool IsBot { get; } /// - /// Returns if this user is a webhook user. + /// Gets if this user is a webhook user. /// bool IsWebhook { get; } ///