Browse Source

Minor fixes in documentations

+ Fix unescaped '<'
+ Fix typo
pull/1161/head
Still Hsu 7 years ago
parent
commit
3a7d7ee955
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
4 changed files with 9 additions and 9 deletions
  1. +2
    -2
      docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md
  2. +2
    -2
      src/Discord.Net.Core/Entities/Emotes/Emote.cs
  3. +1
    -1
      src/Discord.Net.Core/Entities/IMentionable.cs
  4. +4
    -4
      src/Discord.Net.Core/Entities/Users/IUser.cs

+ 2
- 2
docs/_overwrites/Commands/PreconditionAttribute.Overwrites.md View File

@@ -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;
}


+ 2
- 2
src/Discord.Net.Core/Entities/Emotes/Emote.cs View File

@@ -59,7 +59,7 @@ namespace Discord
}

/// <summary> Parses an <see cref="Emote"/> from its raw format. </summary>
/// <param name="text">The raw encoding of an emote; for example, <:dab:277855270321782784&gt;.</param>
/// <param name="text">The raw encoding of an emote; for example, &lt;:dab:277855270321782784&gt;.</param>
/// <returns>An emote.</returns>
/// <exception cref="ArgumentException">Invalid emote format.</exception>
public static Emote Parse(string text)
@@ -70,7 +70,7 @@ namespace Discord
}

/// <summary> Tries to parse an <see cref="Emote"/> from its raw format. </summary>
/// <param name="text">The raw encoding of an emote; for example, <:dab:277855270321782784&gt;.</param>
/// <param name="text">The raw encoding of an emote; for example, &lt;:dab:277855270321782784&gt;.</param>
/// <param name="result">An emote.</param>
public static bool TryParse(string text, out Emote result)
{


+ 1
- 1
src/Discord.Net.Core/Entities/IMentionable.cs View File

@@ -9,7 +9,7 @@ namespace Discord
/// Returns a special string used to mention this object.
/// </summary>
/// <returns>
/// A string that is recognized by Discord as a mention (e.g. <@168693960628371456&gt;).
/// A string that is recognized by Discord as a mention (e.g. &lt;@168693960628371456&gt;).
/// </returns>
string Mention { get; }
}


+ 4
- 4
src/Discord.Net.Core/Entities/Users/IUser.cs View File

@@ -12,7 +12,7 @@ namespace Discord
/// </summary>
string AvatarId { get; }
/// <summary>
/// Gets the URL to this user's avatar.
/// Returns the URL to this user's avatar.
/// </summary>
/// <param name="format">The format to return.</param>
/// <param name="size">
@@ -23,7 +23,7 @@ namespace Discord
/// </returns>
string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128);
/// <summary>
/// Gets the URL to this user's default avatar.
/// Returns the URL to this user's default avatar.
/// </summary>
string GetDefaultAvatarUrl();
/// <summary>
@@ -35,11 +35,11 @@ namespace Discord
/// </summary>
ushort DiscriminatorValue { get; }
/// <summary>
/// Returns <see langword="true"/> if this user is a bot user.
/// Gets <see langword="true"/> if this user is a bot user.
/// </summary>
bool IsBot { get; }
/// <summary>
/// Returns <see langword="true"/> if this user is a webhook user.
/// Gets <see langword="true"/> if this user is a webhook user.
/// </summary>
bool IsWebhook { get; }
/// <summary>


Loading…
Cancel
Save