From a55d329d0b971e146ebdaf749b9725fd8fc7933d Mon Sep 17 00:00:00 2001 From: Tyler Date: Fri, 10 Jul 2020 17:36:09 -0500 Subject: [PATCH 1/5] docs: various doc improvements --- .../caching/structures/channels/Channel.ts | 2 +- .../structures/channels/GuildChannel.ts | 2 +- src/lib/caching/structures/guilds/Guild.ts | 8 +++--- .../caching/structures/guilds/Integration.ts | 2 +- src/lib/caching/structures/guilds/Role.ts | 2 +- .../caching/structures/messages/Message.ts | 28 +++++++++---------- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/lib/caching/structures/channels/Channel.ts b/src/lib/caching/structures/channels/Channel.ts index 2a4f0cd3e..c3fb510be 100644 --- a/src/lib/caching/structures/channels/Channel.ts +++ b/src/lib/caching/structures/channels/Channel.ts @@ -22,7 +22,7 @@ export abstract class Channel extends Structure { public readonly abstract type: ChannelType; /** - * Whether the DM channel is deleted. + * Whether the channel is deleted. * @since 0.0.1 */ public deleted = false; diff --git a/src/lib/caching/structures/channels/GuildChannel.ts b/src/lib/caching/structures/channels/GuildChannel.ts index 052aa5438..e473c3c32 100644 --- a/src/lib/caching/structures/channels/GuildChannel.ts +++ b/src/lib/caching/structures/channels/GuildChannel.ts @@ -109,7 +109,7 @@ export abstract class GuildChannel extends Channel { /** * Checks what permissions a {@link GuildMember member} or {@link Role role} has in this {@link GuildChannel channel} - * @param target The guild member you are checking permissions for + * @param target The guild member or role you are checking permissions for * @param guildScope If we should take into account guild scoped permissions, or just overwrites */ public permissionsFor(target: GuildMember | Role, guildScope = true): Readonly { diff --git a/src/lib/caching/structures/guilds/Guild.ts b/src/lib/caching/structures/guilds/Guild.ts index cda009769..a90d8788f 100644 --- a/src/lib/caching/structures/guilds/Guild.ts +++ b/src/lib/caching/structures/guilds/Guild.ts @@ -153,7 +153,7 @@ export class Guild extends Structure { public readonly integrations: IntegrationStore; /** - * The guild's store of integrations. + * The guild's shard. * @since 0.0.4 */ public readonly shard: WebSocketShard; @@ -292,7 +292,7 @@ export class Guild extends Structure { public banner!: string | null; /** - * The guild's guild Boosting tier + * The guild's Server Boost level. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/guild#guild-object-premium-tier */ @@ -375,7 +375,7 @@ export class Guild extends Structure { } /** - * The Client's member of this guild. + * The Client as a member of this guild. * @since 0.0.1 */ public get me(): GuildMember | null { @@ -498,7 +498,7 @@ export class Guild extends Structure { } /** - * Defines the toString behavior of this structure. + * Defines the toString behavior of guilds. * @since 0.0.4 */ public toString(): string { diff --git a/src/lib/caching/structures/guilds/Integration.ts b/src/lib/caching/structures/guilds/Integration.ts index 1c89abad3..e2b6feb6c 100644 --- a/src/lib/caching/structures/guilds/Integration.ts +++ b/src/lib/caching/structures/guilds/Integration.ts @@ -130,7 +130,7 @@ export class Integration extends Structure { } /** - * Modifies the behaviour and settings of the integration. + * Modifies the behavior and settings of the integration. * @since 0.0.1 * @param options The settings to modify in the integration. * @param requestOptions The additional request options. diff --git a/src/lib/caching/structures/guilds/Role.ts b/src/lib/caching/structures/guilds/Role.ts index fe73126a5..631554db9 100644 --- a/src/lib/caching/structures/guilds/Role.ts +++ b/src/lib/caching/structures/guilds/Role.ts @@ -149,7 +149,7 @@ export class Role extends Structure { } /** - * Defines the toString behavior of this structure. + * Defines the toString behavior of roles. * @since 0.0.4 */ public toString(): string { diff --git a/src/lib/caching/structures/messages/Message.ts b/src/lib/caching/structures/messages/Message.ts index 9db66cf5e..fe402a4c2 100644 --- a/src/lib/caching/structures/messages/Message.ts +++ b/src/lib/caching/structures/messages/Message.ts @@ -35,7 +35,7 @@ export class Message extends WebhookMessage { public readonly guild: Guild | null; /** - * Author of this message. + * Author of the message. * @since 0.0.1 */ public readonly author: User; @@ -59,7 +59,7 @@ export class Message extends WebhookMessage { public readonly attachments: Cache; /** - * When this message was edited (or null if never). + * When the message was edited (or null if never). * @since 0.0.1 */ public editedTimestamp!: number | null; @@ -89,7 +89,7 @@ export class Message extends WebhookMessage { public readonly nonce?: string | null; /** - * Whether or not this message is pinned. + * Whether or not the message is pinned. * @since 0.0.1 */ public pinned!: boolean; @@ -145,7 +145,7 @@ export class Message extends WebhookMessage { } /** - * When this message was sent. + * When the message was sent. * @since 0.0.1 */ public get createdAt(): Date { @@ -153,7 +153,7 @@ export class Message extends WebhookMessage { } /** - * When this message was edited (or null if never). + * When the message was edited (or null if never). * @since 0.0.1 */ public get editedAt(): Date | null { @@ -161,7 +161,7 @@ export class Message extends WebhookMessage { } /** - * If the client can delete this message. + * If the client can delete the message. * @since 0.0.1 */ public get deletable(): boolean | null { @@ -171,7 +171,7 @@ export class Message extends WebhookMessage { } /** - * If the client can edit this message. + * If the client can edit the message. * @since 0.0.1 */ public get editable(): boolean { @@ -179,7 +179,7 @@ export class Message extends WebhookMessage { } /** - * If the client can pin this message. + * If the client can pin the message. * @since 0.0.1 */ public get pinnable(): boolean | null { @@ -189,7 +189,7 @@ export class Message extends WebhookMessage { } /** - * If the client can react to this message. + * If the client can react to the message. * @since 0.0.1 */ public get reactable(): boolean | null { @@ -199,7 +199,7 @@ export class Message extends WebhookMessage { } /** - * The link to this message + * The link to the message * @since 0.0.4 */ get link(): string { @@ -216,7 +216,7 @@ export class Message extends WebhookMessage { } /** - * Crosspost this message. + * Crosspost the message. * @since 0.0.4 */ public crosspost(): Promise { @@ -225,7 +225,7 @@ export class Message extends WebhookMessage { } /** - * Sends a message to the channel. + * Edits the message. * @param data The {@link MessageBuilder builder} to send. * @since 0.0.2 * @see https://discord.com/developers/docs/resources/channel#edit-message @@ -236,7 +236,7 @@ export class Message extends WebhookMessage { */ public edit(data: MessageOptions): Promise; /** - * Sends a message to the channel. + * Edits the message. * @param data A callback with a {@link MessageBuilder builder} as an argument. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/channel#edit-message @@ -271,7 +271,7 @@ export class Message extends WebhookMessage { } /** - * Defines the toString behavior of this structure. + * Defines the toString behavior of messages. * @since 0.0.4 */ public toString(): string { From 76c8cbbcb7bc0dfe022005ad7d608ab78229f47a Mon Sep 17 00:00:00 2001 From: Tyler Date: Fri, 10 Jul 2020 18:13:46 -0500 Subject: [PATCH 2/5] docs: more doc improvements and fixes --- .../caching/structures/channels/Channel.ts | 2 +- .../caching/structures/channels/DMChannel.ts | 8 ++--- .../structures/channels/GuildChannel.ts | 10 +++--- .../structures/channels/GuildTextChannel.ts | 10 +++--- .../structures/channels/NewsChannel.ts | 6 ++-- .../structures/channels/StoreChannel.ts | 2 +- .../structures/channels/TextChannel.ts | 2 +- .../structures/channels/VoiceChannel.ts | 2 +- src/lib/caching/structures/guilds/Ban.ts | 2 +- src/lib/caching/structures/guilds/Guild.ts | 32 +++++++++---------- .../caching/structures/guilds/GuildEmoji.ts | 16 +++++----- .../caching/structures/guilds/GuildMember.ts | 14 ++++---- .../caching/structures/guilds/GuildWidget.ts | 4 +-- .../caching/structures/guilds/Integration.ts | 20 ++++++------ .../caching/structures/guilds/Overwrite.ts | 10 +++--- src/lib/caching/structures/guilds/Presence.ts | 2 +- src/lib/caching/structures/guilds/Role.ts | 2 +- .../caching/structures/guilds/VoiceState.ts | 16 +++++----- 18 files changed, 80 insertions(+), 80 deletions(-) diff --git a/src/lib/caching/structures/channels/Channel.ts b/src/lib/caching/structures/channels/Channel.ts index c3fb510be..062e2c1cc 100644 --- a/src/lib/caching/structures/channels/Channel.ts +++ b/src/lib/caching/structures/channels/Channel.ts @@ -9,7 +9,7 @@ import { Client, ClientEvents } from '../../../client/Client'; export abstract class Channel extends Structure { /** - * The ID of this channel. + * The ID of the channel. * @since 0.0.1 */ public readonly id: string; diff --git a/src/lib/caching/structures/channels/DMChannel.ts b/src/lib/caching/structures/channels/DMChannel.ts index bea099c45..b19ed24d3 100644 --- a/src/lib/caching/structures/channels/DMChannel.ts +++ b/src/lib/caching/structures/channels/DMChannel.ts @@ -19,7 +19,7 @@ import type { Message } from '../messages/Message'; export class DMChannel extends Channel { /** - * The typing handler for this channel. + * The typing handler for the channel. * @since 0.0.1 */ public readonly typing: Typing; @@ -32,13 +32,13 @@ export class DMChannel extends Channel { public readonly type = ChannelType.DM; /** - * The pins store for this channel. + * The pins store for the channel. * @since 0.0.4 */ public readonly pins: ChannelPinsStore; /** - * The id of the last message sent in this channel (may not point to an existing or valid message). + * The id of the last message sent in the channel (may not point to an existing or valid message). * @since 0.0.1 */ public lastMessageID!: string | null; @@ -50,7 +50,7 @@ export class DMChannel extends Channel { public recipients!: User[]; /** - * The message store for this channel. + * The message store for the channel. * @since 0.0.1 */ public readonly messages: MessageStore; diff --git a/src/lib/caching/structures/channels/GuildChannel.ts b/src/lib/caching/structures/channels/GuildChannel.ts index e473c3c32..d6ca1b9c4 100644 --- a/src/lib/caching/structures/channels/GuildChannel.ts +++ b/src/lib/caching/structures/channels/GuildChannel.ts @@ -42,13 +42,13 @@ export abstract class GuildChannel extends Channel { public permissionOverwrites!: OverwriteStore; /** - * The {@link GuildChannelInviteStore invites} store for this channel. + * The {@link GuildChannelInviteStore invites} store for the channel. * @since 0.0.3 */ public readonly invites: GuildChannelInviteStore; /** - * The {@link Guild guild} this channel belongs to. + * The {@link Guild guild} the channel belongs to. * @since 0.0.1 */ public readonly guild: Guild; @@ -62,7 +62,7 @@ export abstract class GuildChannel extends Channel { } /** - * The parent {@type CategoryChannel channel} for this channel. + * The parent {@type CategoryChannel channel} for the channel. * @since 0.0.1 */ public get parent(): CategoryChannel | null { @@ -108,7 +108,7 @@ export abstract class GuildChannel extends Channel { } /** - * Checks what permissions a {@link GuildMember member} or {@link Role role} has in this {@link GuildChannel channel} + * Checks what permissions a {@link GuildMember member} or {@link Role role} has in the {@link GuildChannel channel} * @param target The guild member or role you are checking permissions for * @param guildScope If we should take into account guild scoped permissions, or just overwrites */ @@ -129,7 +129,7 @@ export abstract class GuildChannel extends Channel { } /** - * Modifies this channel. + * Modifies the channel. * @param data The channel modify options. * @param requestOptions The request options. * @since 0.0.1 diff --git a/src/lib/caching/structures/channels/GuildTextChannel.ts b/src/lib/caching/structures/channels/GuildTextChannel.ts index c0a98c402..471d4555e 100644 --- a/src/lib/caching/structures/channels/GuildTextChannel.ts +++ b/src/lib/caching/structures/channels/GuildTextChannel.ts @@ -25,19 +25,19 @@ export interface SendOptions { export abstract class GuildTextChannel extends GuildChannel { /** - * The message store for this channel. + * The message store for the channel. * @since 0.0.1 */ public readonly messages: MessageStore; /** - * The pins store for this channel. + * The pins store for the channel. * @since 0.0.4 */ public readonly pins: ChannelPinsStore; /** - * The typing handler for this channel. + * The typing handler for the channel. * @since 0.0.1 */ public readonly typing: Typing; @@ -55,13 +55,13 @@ export abstract class GuildTextChannel extends GuildChannel { public nsfw!: boolean; /** - * The id of the last message sent in this channel (may not point to an existing or valid message). + * The id of the last message sent in the channel (may not point to an existing or valid message). * @since 0.0.1 */ public lastMessageID!: string | null; /** - * When the last pinned message was pinned. + * When the last pinned message was pinned in the channel. * @since 0.0.1 */ public lastPinTimestamp!: string | null; diff --git a/src/lib/caching/structures/channels/NewsChannel.ts b/src/lib/caching/structures/channels/NewsChannel.ts index bb2108009..fd6869f31 100644 --- a/src/lib/caching/structures/channels/NewsChannel.ts +++ b/src/lib/caching/structures/channels/NewsChannel.ts @@ -18,7 +18,7 @@ export class NewsChannel extends GuildTextChannel { public readonly type = ChannelType.GuildNews; /** - * Crossposts a Message in this channel. + * Crossposts a Message in the channel. * @param messageID The ID of the {@link Message message} that should be crossposted. * @since 0.0.1 */ @@ -29,7 +29,7 @@ export class NewsChannel extends GuildTextChannel { } /* - * Subscribes a channel to crossposted messages from this channel. + * Subscribes a channel to crossposted messages from the channel. * @param channel The {@link GuildTextChannel channel} that should follow this NewsChannel. * @since 0.0.4 */ @@ -39,7 +39,7 @@ export class NewsChannel extends GuildTextChannel { } /** - * Modifies this channel. + * Modifies the channel. * @param data The channel modify options. * @param requestOptions The request options. * @since 0.0.1 diff --git a/src/lib/caching/structures/channels/StoreChannel.ts b/src/lib/caching/structures/channels/StoreChannel.ts index 2d9e5ca2e..59e529f68 100644 --- a/src/lib/caching/structures/channels/StoreChannel.ts +++ b/src/lib/caching/structures/channels/StoreChannel.ts @@ -22,7 +22,7 @@ export class StoreChannel extends GuildChannel { public nsfw!: boolean; /** - * Modifies this channel. + * Modifies the channel. * @param data The channel modify options. * @param requestOptions The request options. * @since 0.0.1 diff --git a/src/lib/caching/structures/channels/TextChannel.ts b/src/lib/caching/structures/channels/TextChannel.ts index 93fbdf469..def01c93c 100644 --- a/src/lib/caching/structures/channels/TextChannel.ts +++ b/src/lib/caching/structures/channels/TextChannel.ts @@ -24,7 +24,7 @@ export class TextChannel extends GuildTextChannel { public rateLimitPerUser!: number; /** - * Modifies this channel. + * Modifies the channel. * @param data The channel modify options. * @param requestOptions The request options. * @since 0.0.1 diff --git a/src/lib/caching/structures/channels/VoiceChannel.ts b/src/lib/caching/structures/channels/VoiceChannel.ts index 6f64e99de..7a79a43f4 100644 --- a/src/lib/caching/structures/channels/VoiceChannel.ts +++ b/src/lib/caching/structures/channels/VoiceChannel.ts @@ -49,7 +49,7 @@ export class VoiceChannel extends GuildChannel { } /** - * Modifies this channel. + * Modifies the channel. * @param data The channel modify options. * @param requestOptions The request options. * @since 0.0.1 diff --git a/src/lib/caching/structures/guilds/Ban.ts b/src/lib/caching/structures/guilds/Ban.ts index 016c59544..0b8bbd920 100644 --- a/src/lib/caching/structures/guilds/Ban.ts +++ b/src/lib/caching/structures/guilds/Ban.ts @@ -24,7 +24,7 @@ export class Ban extends Structure { public readonly reason: string | null; /** - * The guild this ban is from. + * The guild the ban is from. * @since 0.0.1 */ public readonly guild: Guild; diff --git a/src/lib/caching/structures/guilds/Guild.ts b/src/lib/caching/structures/guilds/Guild.ts index a90d8788f..ef7ddbee6 100644 --- a/src/lib/caching/structures/guilds/Guild.ts +++ b/src/lib/caching/structures/guilds/Guild.ts @@ -209,13 +209,13 @@ export class Guild extends Structure { public rulesChannelID!: string | null; /** - * When this guild was joined at. + * When the guild was joined at. * @since 0.0.1 */ public joinedTimestamp!: number | null; /** - * Whether this is considered a large guild. + * Whether the is considered a large guild. * @since 0.0.1 */ public large!: boolean | null; @@ -227,34 +227,34 @@ export class Guild extends Structure { public unavailable: boolean; /** - * Total number of members in this guild. This field will only be present if a guild was received from the `GUILD_CREATE` event. + * Total number of members in the guild. This field will only be present if a guild was received from the `GUILD_CREATE` event. * @since 0.0.1 */ public memberCount!: number | null; /** - * A store of voice states for this guild. + * A store of voice states for the guild. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/voice#voice-state-object */ public readonly voiceStates: VoiceStateStore; /** - * A store of members for this guild. + * A store of members for the guild. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/guild#guild-member-object */ public readonly members: GuildMemberStore; /** - * A store of channels for this guild. + * A store of channels for the guild. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/channel#channel-object */ public readonly channels: GuildChannelStore; /** - * A store of presences for this guild. + * A store of presences for the guild. * @since 0.0.1 * @see https://discord.com/developers/docs/topics/gateway#presence-update */ @@ -299,7 +299,7 @@ export class Guild extends Structure { public premiumTier!: GuildPremiumTier | null; /** - * The number of boosts this guild currently has. + * The number of boosts the guild currently has. * @since 0.0.1 */ public premiumSubscriptionCount!: number | null; @@ -317,19 +317,19 @@ export class Guild extends Structure { public publicUpdatesChannel!: string | null; /** - * The approximate number of members in this guild, returned from the `GET /guild/` endpoint when `with_counts` is `true`. + * The approximate number of members in the guild, returned from the `GET /guild/` endpoint when `with_counts` is `true`. * @since 0.0.1 */ public approximateMemberCount?: number; /** - * The approximate number of online members in this guild, returned from the `GET /guild/` endpoint when `with_counts` is `true`. + * The approximate number of online members in the guild, returned from the `GET /guild/` endpoint when `with_counts` is `true`. * @since 0.0.1 */ public approximatePresenceCount?: number; /** - * The widget for this guild. + * The widget for the guild. * @since 0.0.1 */ public widget: GuildWidget; @@ -367,7 +367,7 @@ export class Guild extends Structure { } /** - * When this guild was joined at, as a Date. + * When the guild was joined at, as a Date. * @since 0.0.1 */ public get joinedAt(): Date | null { @@ -375,7 +375,7 @@ export class Guild extends Structure { } /** - * The Client as a member of this guild. + * The Client as a member of the guild. * @since 0.0.1 */ public get me(): GuildMember | null { @@ -384,7 +384,7 @@ export class Guild extends Structure { } /** - * The owner of this guild. + * The owner of the guild. * @since 0.0.1 */ public get owner(): GuildMember | null { @@ -726,14 +726,14 @@ export type GuildPruneOptions = GuildPruneDryOptions | GuildPruneNonDryOptions; */ export interface GuildVanityURL { /** - * The code of this invite. + * The code of the invite. * @since 0.0.1 * @example "discord" */ code: string; /** - * The amount of uses this invite has. + * The amount of uses the invite has. * @since 0.0.1 * @example 42 */ diff --git a/src/lib/caching/structures/guilds/GuildEmoji.ts b/src/lib/caching/structures/guilds/GuildEmoji.ts index c9eb1836c..74398356b 100644 --- a/src/lib/caching/structures/guilds/GuildEmoji.ts +++ b/src/lib/caching/structures/guilds/GuildEmoji.ts @@ -23,49 +23,49 @@ export class GuildEmoji extends Structure { public name!: string | null; /** - * The roles this emoji is whitelisted to. + * The roles the emoji is whitelisted to. * @since 0.0.1 */ public roleIDs!: string[]; /** - * User that created this emoji. + * User that created the emoji. * @since 0.0.1 */ public userID!: string | null; /** - * Whether or not this emoji must be wrapped in colons. + * Whether or not the emoji must be wrapped in colons. * @since 0.0.1 */ public requireColons!: boolean | null; /** - * Whether or not this emoji is managed. + * Whether or not the emoji is managed. * @since 0.0.1 */ public managed!: boolean | null; /** - * Whether this emoji is animated. + * Whether the emoji is animated. * @since 0.0.1 */ public animated!: boolean | null; /** - * Whether or not this emoji can be used, may be false due to loss of Server Boosts. + * Whether or not the emoji can be used, may be false due to loss of Server Boosts. * @since 0.0.1 */ public available!: boolean; /** - * The guild this emoji is from. + * The guild the emoji is from. * @since 0.0.1 */ public readonly guild: Guild; /** - * Whether the integration is deleted. + * Whether the emoji is deleted. * @since 0.0.1 */ public deleted = false; diff --git a/src/lib/caching/structures/guilds/GuildMember.ts b/src/lib/caching/structures/guilds/GuildMember.ts index 194965e93..00e28cffc 100644 --- a/src/lib/caching/structures/guilds/GuildMember.ts +++ b/src/lib/caching/structures/guilds/GuildMember.ts @@ -58,7 +58,7 @@ export class GuildMember extends Structure { public premiumSince!: number | null; /** - * The roles this member has. + * The roles the member has. * @since 0.0.1 */ public roles!: GuildMemberRoleStore; @@ -78,7 +78,7 @@ export class GuildMember extends Structure { } /** - * The user for this member + * The {@link User user} for the member * @since 0.0.1 */ public get user(): User | null { @@ -105,7 +105,7 @@ export class GuildMember extends Structure { } /** - * Whether or not the {@link ClientUser client user} can kick this member. + * Whether or not the {@link ClientUser client user} can kick the member. * @since 0.0.1 * @returns `null` when the {@link ClientUser client user}'s member is not cached (or when {@link Client#user} is null), * or a boolean specifying whether or not the conditions are met. @@ -115,7 +115,7 @@ export class GuildMember extends Structure { } /** - * Whether or not the {@link ClientUser client user} can ban this member. + * Whether or not the {@link ClientUser client user} can ban the member. * @since 0.0.1 * @returns `null` when the {@link ClientUser client user}'s member is not cached (or when {@link Client#user} is null), * or a boolean specifying whether or not the conditions are met. @@ -145,7 +145,7 @@ export class GuildMember extends Structure { } /** - * Whether or not the {@link ClientUser client user} can manage this member. This is based on: + * Whether or not the {@link ClientUser client user} can manage the member. This is based on: * - The member is not the {@link Guild#owner guild owner}. * - The {@link ClientUser client user} is the owner of the {@link Guild}. * - The {@link ClientUser client user}'s {@link GuildMemberRoleStore#highest highest role} is higher than the member's. @@ -186,7 +186,7 @@ export class GuildMember extends Structure { } /** - * Checks permissions for this member in a given channel. + * Checks permissions for the member in a given channel. * @param channel The channel to check permissions in * @param guildScope If we should take into account guild scoped permissions, or just overwrites */ @@ -276,7 +276,7 @@ export interface GuildMemberModifyOptions { deaf?: boolean; /** - * Id of channel to move user to (if they are connected to a {@link VoiceChannel voice channel}). + * Id of channel to move the user to (if they are connected to a {@link VoiceChannel voice channel}). * @since 0.0.1 */ channel_id?: string | null; diff --git a/src/lib/caching/structures/guilds/GuildWidget.ts b/src/lib/caching/structures/guilds/GuildWidget.ts index a8d3a9fe3..f55f30334 100644 --- a/src/lib/caching/structures/guilds/GuildWidget.ts +++ b/src/lib/caching/structures/guilds/GuildWidget.ts @@ -12,13 +12,13 @@ import type { GuildBasedChannel } from '../../../util/Util'; export class GuildWidget { /** - * The {@link Client client} this store belongs to. + * The {@link Client client} the widget belongs to. * @since 0.0.1 */ public readonly client: Client; /** - * The {@link Guild guild} this store belongs to. + * The {@link Guild guild} the widget belongs to. * @since 0.0.1 */ public readonly guild: Guild; diff --git a/src/lib/caching/structures/guilds/Integration.ts b/src/lib/caching/structures/guilds/Integration.ts index e2b6feb6c..76ce92bc6 100644 --- a/src/lib/caching/structures/guilds/Integration.ts +++ b/src/lib/caching/structures/guilds/Integration.ts @@ -14,7 +14,7 @@ import type { User } from '../User'; export class Integration extends Structure { /** - * The {@link Guild guild} this integration belongs to. + * The {@link Guild guild} the integration belongs to. * @since 0.0.1 */ public readonly guild: Guild; @@ -38,25 +38,25 @@ export class Integration extends Structure { public readonly type: string; /** - * Whether this integration is enabled. + * Whether the integration is enabled. * @since 0.0.1 */ public readonly enabled: boolean; /** - * Whether this integration is syncing. + * Whether the integration is syncing. * @since 0.0.1 */ public readonly syncing: boolean; /** - * The {@link Role role} ID that this integration uses for "subscribers". + * The {@link Role role} ID that the integration uses for "subscribers". * @since 0.0.1 */ public readonly roleID: string; /** - * The {@link User user} ID for this integration. + * The {@link User user} ID for the integration. * @since 0.0.1 */ public readonly userID: string; @@ -68,7 +68,7 @@ export class Integration extends Structure { public readonly account: APIIntegrationAccountData; /** - * Whether emoticons should be synced for this integration (twitch only currently). + * Whether emoticons should be synced for the integration (twitch only currently). * @since 0.0.1 */ public enableEmoticons!: boolean | null; @@ -87,7 +87,7 @@ export class Integration extends Structure { public expireGracePeriod!: number; /** - * When this integration was last synced. + * When the integration was last synced. * @since 0.0.1 */ public syncedTimestamp!: number; @@ -114,7 +114,7 @@ export class Integration extends Structure { } /** - * The {@link User user} for this integration. + * The {@link User user} for the integration. * @since 0.0.1 */ public get user(): User | null { @@ -122,7 +122,7 @@ export class Integration extends Structure { } /** - * The {@link Role role} that this integration uses for "subscribers". + * The {@link Role role} that the integration uses for "subscribers". * @since 0.0.1 */ public get role(): Role | null { @@ -196,7 +196,7 @@ export interface IntegrationModifyOptions { expire_grace_period?: number | null; /** - * Whether emoticons should be synced for this integration (twitch only currently). + * Whether emoticons should be synced for the integration (twitch only currently). * @since 0.0.1 */ enable_emoticons?: boolean | null; diff --git a/src/lib/caching/structures/guilds/Overwrite.ts b/src/lib/caching/structures/guilds/Overwrite.ts index 2568bbdb9..afceddc22 100644 --- a/src/lib/caching/structures/guilds/Overwrite.ts +++ b/src/lib/caching/structures/guilds/Overwrite.ts @@ -20,7 +20,7 @@ export class Overwrite extends Structure { public readonly id: string; /** - * The {@link GuildChannel channel} this is for. + * The {@link GuildChannel channel} the overwrite is for. * @since 0.0.1 */ public readonly channel: GuildChannel; @@ -32,13 +32,13 @@ export class Overwrite extends Structure { public type!: 'role' | 'member'; /** - * The allowed permissions in this overwrite. + * The allowed permissions in the overwrite. * @since 0.0.1 */ public allow!: Readonly; /** - * The denied permissions in this overwrite. + * The denied permissions in the overwrite. * @since 0.0.1 */ public deny!: Readonly; @@ -58,7 +58,7 @@ export class Overwrite extends Structure { } /** - * Deletes this overwrite. + * Deletes the overwrite. * @param requestOptions The additional request options. */ public async delete(requestOptions: RequestOptions = {}): Promise { @@ -67,7 +67,7 @@ export class Overwrite extends Structure { } /** - * Modifies this overwrite. + * Modifies the overwrite. * @param options The modify options * @param requestOptions The additional request options. */ diff --git a/src/lib/caching/structures/guilds/Presence.ts b/src/lib/caching/structures/guilds/Presence.ts index 10c228c19..83a0b9371 100644 --- a/src/lib/caching/structures/guilds/Presence.ts +++ b/src/lib/caching/structures/guilds/Presence.ts @@ -9,7 +9,7 @@ import type { Client } from '../../../client/Client'; export class Presence extends Structure { /** - * The member's ID this presence corresponds to. + * The member's ID the presence corresponds to. * @since 0.0.1 */ public readonly id: string; diff --git a/src/lib/caching/structures/guilds/Role.ts b/src/lib/caching/structures/guilds/Role.ts index 631554db9..f9a742cdf 100644 --- a/src/lib/caching/structures/guilds/Role.ts +++ b/src/lib/caching/structures/guilds/Role.ts @@ -81,7 +81,7 @@ export class Role extends Structure { } /** - * Checks permissions for this member in a given channel. + * Checks permissions for the role in a given channel. * @param channel The channel to check permissions in * @param guildScope If we should take into account guild scoped permissions, or just overwrites */ diff --git a/src/lib/caching/structures/guilds/VoiceState.ts b/src/lib/caching/structures/guilds/VoiceState.ts index 41876f496..029cc24bf 100644 --- a/src/lib/caching/structures/guilds/VoiceState.ts +++ b/src/lib/caching/structures/guilds/VoiceState.ts @@ -10,13 +10,13 @@ import type { Guild } from './Guild'; export class VoiceState extends Structure { /** - * The user id this voice state is for. + * The user id the voice state is for. * @since 0.0.1 */ public readonly id: string; /** - * The channel id this user is connected to. + * The channel id the user is connected to. * @since 0.0.1 */ public channelID!: string | null; @@ -28,37 +28,37 @@ export class VoiceState extends Structure { public sessionID!: string; /** - * Whether or not this user is deafened by the server. + * Whether or not the user is deafened by the server. * @since 0.0.1 */ public deaf!: boolean; /** - * Whether or not this user is muted by the server. + * Whether or not the user is muted by the server. * @since 0.0.1 */ public mute!: boolean; /** - * Whether or not this user is locally deafened. + * Whether or not the user is locally deafened. * @since 0.0.1 */ public selfDeaf!: boolean; /** - * Whether or not this user is locally muted. + * Whether or not the user is locally muted. * @since 0.0.1 */ public selfMute!: boolean; /** - * Whether or not this user is streaming using "Go Live". + * Whether or not the user is streaming using "Go Live". * @since 0.0.1 */ public selfStream!: boolean | null; /** - * Whether or not this user is muted by the current user. + * Whether or not the user is muted by the current user. * @since 0.0.1 */ public suppress!: boolean; From 0cf8e8651f8316df29ec4545fedf6f56e3c07dcf Mon Sep 17 00:00:00 2001 From: Tyler Date: Fri, 10 Jul 2020 18:42:29 -0500 Subject: [PATCH 3/5] docs: even more doc improvements and fixes --- src/lib/caching/structures/Embed.ts | 6 +++--- src/lib/caching/structures/Invite.ts | 8 ++++---- src/lib/caching/structures/User.ts | 14 +++++++------- src/lib/caching/structures/Webhook.ts | 16 ++++++++-------- .../structures/messages/MessageBuilder.ts | 14 +++++++------- .../structures/messages/MessageMentions.ts | 8 ++++---- .../structures/messages/WebhookMessage.ts | 10 +++++----- .../structures/messages/WebhookMessageBuilder.ts | 6 +++--- .../messages/reactions/MessageReaction.ts | 4 ++-- .../messages/reactions/MessageReactionEmoji.ts | 2 +- src/lib/caching/structures/oauth/Application.ts | 12 ++++++------ src/lib/caching/structures/oauth/Team.ts | 4 ++-- src/lib/caching/structures/oauth/TeamMember.ts | 2 +- 13 files changed, 53 insertions(+), 53 deletions(-) diff --git a/src/lib/caching/structures/Embed.ts b/src/lib/caching/structures/Embed.ts index dd80adbf7..d8bc30f3e 100644 --- a/src/lib/caching/structures/Embed.ts +++ b/src/lib/caching/structures/Embed.ts @@ -274,7 +274,7 @@ export class Embed implements APIEmbedData { } /** - * Sets the image url you would like + * Sets the thumbnail url you would like * @param url The url of the image */ public setThumbnail(url?: StringResolvable): this { @@ -283,7 +283,7 @@ export class Embed implements APIEmbedData { } /** - * Updates the image data you would like + * Updates the thumbnail data you would like * @param data The fields you want to update */ public updateThumbnail(data: APIEmbedImageData): this { @@ -318,7 +318,7 @@ export class Embed implements APIEmbedData { } /** - * Sets the title of the embed + * Sets the description of the embed * @param description The description you want */ public setDescription(description?: StringResolvable): this { diff --git a/src/lib/caching/structures/Invite.ts b/src/lib/caching/structures/Invite.ts index f168d9061..d0a22e9be 100644 --- a/src/lib/caching/structures/Invite.ts +++ b/src/lib/caching/structures/Invite.ts @@ -18,13 +18,13 @@ export class Invite extends Structure { public readonly id: string; /** - * The guild this invite is for. + * The guild the invite is for. * @since 0.0.1 */ public readonly guild: Guild | null; /** - * The channel this invite is for. + * The channel the invite is for. * @since 0.0.1 */ public readonly channel: Channel; @@ -36,13 +36,13 @@ export class Invite extends Structure { public inviter!: User | null; /** - * The target user for this invite. + * The target user for the invite. * @since 0.0.1 */ public targetUser!: User | null; /** - * The type of user target for this invite. + * The type of user target for the invite. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/invite#invite-object-target-user-types */ diff --git a/src/lib/caching/structures/User.ts b/src/lib/caching/structures/User.ts index 629e25ce6..3db082fde 100644 --- a/src/lib/caching/structures/User.ts +++ b/src/lib/caching/structures/User.ts @@ -61,7 +61,7 @@ export class User extends Structure { public locale?: string; /** - * Whether or not the email on this account has been verified. + * Whether or not the email on the user's account has been verified. * @since 0.0.1 */ public verified?: boolean; @@ -94,7 +94,7 @@ export class User extends Structure { public publicFlags?: APIUserFlags; /** - * The id for the last message recieved for this user + * The id for the last message recieved for the user * @since 0.0.3 */ public lastMessageID: string | null = null; @@ -115,7 +115,7 @@ export class User extends Structure { } /** - * Returns the users username and discriminator. + * Returns the user's username and discriminator. * @since 0.0.1 */ public get tag(): string { @@ -123,7 +123,7 @@ export class User extends Structure { } /** - * Gets or Fetches a DM channel for this user. + * Gets or Fetches a DM channel for the user. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/user#create-dm */ @@ -135,7 +135,7 @@ export class User extends Structure { } /** - * Closes a DM channel for this user if one exists. + * Closes a DM channel for the user if one exists. * @since 0.0.1 * @see https://discord.com/developers/docs/resources/channel#deleteclose-channel */ @@ -154,7 +154,7 @@ export class User extends Structure { } /** - * Returns the users avatar url or the default discord avatar url if they don't have a avatar. + * Returns the user's avatar url or the default discord avatar url if they don't have a avatar. * @param options The image size, format and other options. */ public displayAvatarURL(options?: ImageURLOptions): string | null { @@ -173,7 +173,7 @@ export class User extends Structure { } /** - * Defines toString behavior for members. + * Defines toString behavior for users. * @since 0.0.1 */ public toString(): string { diff --git a/src/lib/caching/structures/Webhook.ts b/src/lib/caching/structures/Webhook.ts index 24f5a1bd6..baa005262 100644 --- a/src/lib/caching/structures/Webhook.ts +++ b/src/lib/caching/structures/Webhook.ts @@ -33,12 +33,12 @@ export class Webhook extends Structure { public type: WebhookType; /** - * The guildID this webhook is for + * The guildID the webhook is for */ public guildID: string | null; /** - * The channelID this webhook is for + * The channelID the webhook is for */ public channelID!: string; @@ -53,12 +53,12 @@ export class Webhook extends Structure { public name: string | null = null; /** - * The avatar used for this webhook + * The avatar used for the webhook */ public avatar: string | null = null; /** - * The token for this webhook + * The token for the webhook */ public token: string | null; @@ -68,7 +68,7 @@ export class Webhook extends Structure { public deleted = false; /** - * @param client The client to manage this webhook + * @param client The client to manage the webhook * @param data The webhook data */ public constructor(client: Client | WebhookClient, data: APIWebhookData, token?: string) { @@ -96,14 +96,14 @@ export class Webhook extends Structure { } /** - * The guild that this webhook is in + * The guild that the webhook is in */ get guild(): Guild | null { return (this.guildID && (this.client as Client).guilds?.get(this.guildID)) || null; } /** - * The channel of this webhook + * The channel of the webhook */ get channel(): Channel | null { return (this.client as Client).channels?.get(this.channelID) ?? null; @@ -161,7 +161,7 @@ export class Webhook extends Structure { } /** - * Delete this webhook from the api + * Delete the webhook from the api */ public async delete(): Promise { await (this.token ? diff --git a/src/lib/caching/structures/messages/MessageBuilder.ts b/src/lib/caching/structures/messages/MessageBuilder.ts index a7a664bae..49f47ca6e 100644 --- a/src/lib/caching/structures/messages/MessageBuilder.ts +++ b/src/lib/caching/structures/messages/MessageBuilder.ts @@ -65,7 +65,7 @@ export class MessageBuilder implements RequiredExcept; /** - * Roles specifically mentioned in this message. + * Roles specifically mentioned in the message. * @since 0.0.1 */ public readonly roles: Cache; /** - * Channels specifically mentioned in this message. + * Channels specifically mentioned in the message. * @since 0.0.1 */ public readonly channels: Cache; /** - * Whether this message mentions everyone. + * Whether the message mentions everyone. * @since 0.0.1 */ public readonly everyone: boolean; diff --git a/src/lib/caching/structures/messages/WebhookMessage.ts b/src/lib/caching/structures/messages/WebhookMessage.ts index 87f189bc6..24ae70ef9 100644 --- a/src/lib/caching/structures/messages/WebhookMessage.ts +++ b/src/lib/caching/structures/messages/WebhookMessage.ts @@ -15,7 +15,7 @@ export class WebhookMessage extends Structure { public readonly id: string; /** - * Author of this message. + * Author of the message. * @since 0.0.1 */ public readonly author: User; @@ -27,7 +27,7 @@ export class WebhookMessage extends Structure { public content: string; /** - * Whether or not this was a TTS message. + * Whether or not the was a TTS message. * @since 0.0.1 */ public tts!: boolean; @@ -45,7 +45,7 @@ export class WebhookMessage extends Structure { public readonly nonce?: string | null; /** - * If the message is generated by a webhook, this is the webhook's id. + * If the message is generated by a webhook, the is the webhook's id. * @since 0.0.1 */ public readonly webhookID?: string | null; @@ -70,7 +70,7 @@ export class WebhookMessage extends Structure { } /** - * When this message was sent. + * When the message was sent. * @since 0.0.1 */ public get createdAt(): Date { @@ -78,7 +78,7 @@ export class WebhookMessage extends Structure { } /** - * Defines the toString behavior of this structure. + * Defines the toString behavior of messages. * @since 0.0.4 */ public toString(): string { diff --git a/src/lib/caching/structures/messages/WebhookMessageBuilder.ts b/src/lib/caching/structures/messages/WebhookMessageBuilder.ts index 86673bd20..21761f1e5 100644 --- a/src/lib/caching/structures/messages/WebhookMessageBuilder.ts +++ b/src/lib/caching/structures/messages/WebhookMessageBuilder.ts @@ -43,7 +43,7 @@ export class WebhookMessageBuilder extends MessageBuilder implements RequiredExc public auth = false; /** - * @param webhookMessageOptions The options to create this + * @param webhookMessageOptions The options to create the webhook message */ public constructor({ data = {}, files = [] }: WebhookMessageOptions = {}) { super(); @@ -68,7 +68,7 @@ export class WebhookMessageBuilder extends MessageBuilder implements RequiredExc } /** - * Adds an embed to this webhook message + * Adds an embed to the webhook message * @param embed The field name */ public addEmbed(embed: APIEmbedData): this @@ -114,7 +114,7 @@ export class WebhookMessageBuilder extends MessageBuilder implements RequiredExc } /** - * Splits this into multiple messages. + * Splits the message into multiple messages. * @param options Options to split the message by. */ public split(options: SplitOptions = {}): RequestOptions[] { diff --git a/src/lib/caching/structures/messages/reactions/MessageReaction.ts b/src/lib/caching/structures/messages/reactions/MessageReaction.ts index 238d1d4a6..92152f9fb 100644 --- a/src/lib/caching/structures/messages/reactions/MessageReaction.ts +++ b/src/lib/caching/structures/messages/reactions/MessageReaction.ts @@ -42,7 +42,7 @@ export class MessageReaction extends Structure { public readonly users: MessageReactionUserStore; /** - * The {@link Message message} instance this is tied to. + * The {@link Message message} instance the reaction is tied to. * @since 0.0.1 */ public readonly message: Message; @@ -65,7 +65,7 @@ export class MessageReaction extends Structure { } /** - * Defines the JSON.stringify behavior of this structure. + * Defines the JSON.stringify behavior of message reactions. * @since 0.0.1 */ public toJSON(): Record { diff --git a/src/lib/caching/structures/messages/reactions/MessageReactionEmoji.ts b/src/lib/caching/structures/messages/reactions/MessageReactionEmoji.ts index 8dd132e8c..ec40a2cbe 100644 --- a/src/lib/caching/structures/messages/reactions/MessageReactionEmoji.ts +++ b/src/lib/caching/structures/messages/reactions/MessageReactionEmoji.ts @@ -19,7 +19,7 @@ export class MessageReactionEmoji implements APIEmojiPartial { public readonly name: string | null; /** - * Whether this emoji is animated. + * Whether the emoji is animated. * @since 0.0.1 */ public readonly animated: boolean; diff --git a/src/lib/caching/structures/oauth/Application.ts b/src/lib/caching/structures/oauth/Application.ts index b0c89d23b..ffc045d68 100644 --- a/src/lib/caching/structures/oauth/Application.ts +++ b/src/lib/caching/structures/oauth/Application.ts @@ -60,7 +60,7 @@ export class Application { public owner: User; /** - * If this application is a game sold on Discord, this field will be the summary field for the store page of its primary sku. + * If the application is a game sold on Discord, this field will be the summary field for the store page of its primary sku. * @since 0.0.1 */ public summary: string; @@ -79,25 +79,25 @@ export class Application { public team: Team | null; /** - * If this application is a game sold on Discord, this field will be the guild to which it has been linked. + * If the application is a game sold on Discord, this field will be the guild to which it has been linked. * @since 0.0.1 */ public guildID: string | null; /** - * If this application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists. + * If the application is a game sold on Discord, this field will be the id of the "Game SKU" that is created, if exists. * @since 0.0.1 */ public primarySkuID: string | null; /** - * If this application is a game sold on Discord, this field will be the URL slug that links to the store page. + * If the application is a game sold on Discord, this field will be the URL slug that links to the store page. * @since 0.0.1 */ public slug: string | null; /** - * If this application is a game sold on Discord, this field will be the hash of the image on store embeds. + * If the application is a game sold on Discord, this field will be the hash of the image on store embeds. * @since 0.0.1 */ public coverImage: string | null; @@ -122,7 +122,7 @@ export class Application { } /** - * The guild for this application if applicable. + * The guild for the application if applicable. * @since 0.0.4 */ public get guild(): Guild | null { diff --git a/src/lib/caching/structures/oauth/Team.ts b/src/lib/caching/structures/oauth/Team.ts index 4eb249b8c..bda7679cd 100644 --- a/src/lib/caching/structures/oauth/Team.ts +++ b/src/lib/caching/structures/oauth/Team.ts @@ -42,7 +42,7 @@ export class Team { } /** - * The owner of this Team + * The owner of the team * @since 0.0.4 */ public get owner(): TeamMember { @@ -50,7 +50,7 @@ export class Team { } /** - * Returns the teams icon url if available. + * Returns the team's icon url if available. * @param options The image size, format, and other image url options. */ public iconURL(options?: ImageURLOptions): string | null { diff --git a/src/lib/caching/structures/oauth/TeamMember.ts b/src/lib/caching/structures/oauth/TeamMember.ts index 3f9a8a08c..3397073d5 100644 --- a/src/lib/caching/structures/oauth/TeamMember.ts +++ b/src/lib/caching/structures/oauth/TeamMember.ts @@ -20,7 +20,7 @@ export class TeamMember { public permissions: string[]; /** - * The {@link User} this represents. + * The {@link User} of the team member. * @since 0.0.4 */ public user: User; From 770973a73f5d22a19e6d45da0fe7701a3f39c0a9 Mon Sep 17 00:00:00 2001 From: Tyler Date: Sun, 12 Jul 2020 17:50:33 -0500 Subject: [PATCH 4/5] docs: a couple more doc improvements and fixes --- src/lib/pieces/Action.ts | 4 ++-- src/lib/pieces/ActionStore.ts | 2 +- src/lib/pieces/Event.ts | 4 ++-- src/lib/pieces/EventStore.ts | 2 +- src/lib/util/ImageUtil.ts | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/lib/pieces/Action.ts b/src/lib/pieces/Action.ts index 839643e54..850091f30 100644 --- a/src/lib/pieces/Action.ts +++ b/src/lib/pieces/Action.ts @@ -19,10 +19,10 @@ export abstract class Action { /** * @since 0.0.1 - * @param client The client this Store was created with + * @param client The client the Store was created with */ public constructor(client: Client) { super(client, 'actions', Action as PieceConstructor); diff --git a/src/lib/pieces/Event.ts b/src/lib/pieces/Event.ts index e731072a8..e4d27a797 100644 --- a/src/lib/pieces/Event.ts +++ b/src/lib/pieces/Event.ts @@ -35,10 +35,10 @@ export abstract class Event extends Piece { /** * @since 0.0.1 - * @param store The store this piece is for + * @param store The store the piece is for * @param directory The base directory to the pieces folder * @param file The path from the pieces folder to the piece file - * @param options The options for this piece + * @param options The options for the piece */ public constructor(store: EventStore, directory: string, file: readonly string[], options: EventOptions = {}) { super(store, directory, file, options); diff --git a/src/lib/pieces/EventStore.ts b/src/lib/pieces/EventStore.ts index 1278b3a63..6a795197f 100644 --- a/src/lib/pieces/EventStore.ts +++ b/src/lib/pieces/EventStore.ts @@ -24,7 +24,7 @@ export class EventStore extends Store { } /** - * Loads a piece into Klasa so it can be saved in this store. + * Loads a piece into Klasa so it can be saved in the store. * @since 0.0.1 * @param file A string or array of strings showing where the file is located. * @param core If the file is located in the core directory or not diff --git a/src/lib/util/ImageUtil.ts b/src/lib/util/ImageUtil.ts index f43766813..b96c69a89 100644 --- a/src/lib/util/ImageUtil.ts +++ b/src/lib/util/ImageUtil.ts @@ -5,7 +5,7 @@ import { promises as fsp } from 'fs'; import { MessageAttachment } from '../caching/structures/messages/MessageAttachment'; /** - * @param buffer The buffer the sniff the magic numbers from. + * @param buffer The buffer to sniff the magic numbers from. * @see https://en.wikipedia.org/wiki/GIF * @private */ @@ -21,7 +21,7 @@ function isGif(buffer: Buffer): boolean { } /** - * @param buffer The buffer the sniff the magic numbers from. + * @param buffer The buffer to sniff the magic numbers from. * @see https://en.wikipedia.org/wiki/JPEG * @private */ @@ -34,7 +34,7 @@ function isJpeg(buffer: Buffer): boolean { } /** - * @param buffer The buffer the sniff the magic numbers from. + * @param buffer The buffer to sniff the magic numbers from. * @see https://en.wikipedia.org/wiki/Portable_Network_Graphics * @private */ @@ -52,7 +52,7 @@ function isPng(buffer: Buffer): boolean { } /** - * @param buffer The buffer the sniff the magic numbers from. + * @param buffer The buffer to sniff the magic numbers from. * @see https://en.wikipedia.org/wiki/WebP * @private */ From 91cca0570cf18c0a58fd734865f68979f8d58982 Mon Sep 17 00:00:00 2001 From: Tyler Richards <11968358+tjrgg@users.noreply.github.com> Date: Sun, 26 Jul 2020 20:26:51 -0500 Subject: [PATCH 5/5] docs: a small, but important improvement Co-authored-by: Vlad Frangu --- src/lib/caching/structures/User.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/caching/structures/User.ts b/src/lib/caching/structures/User.ts index 4f75dedc5..4297844d5 100644 --- a/src/lib/caching/structures/User.ts +++ b/src/lib/caching/structures/User.ts @@ -94,7 +94,7 @@ export class User extends Structure { public publicFlags?: APIUserFlags; /** - * The id for the last message recieved for the user + * The id for the last message received from the user * @since 0.0.3 */ public lastMessageID: string | null = null;