docs: various documentation improvements and fixes

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 {

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
 	 */

src/lib/caching/structures/User.ts

@@ -61,7 +61,7 @@ export class User<T = Client> extends Structure<T> {
 	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<T = Client> extends Structure<T> {
 	public publicFlags?: APIUserFlags;
 
 	/**
-	 * The id for the last message recieved for this user
+	 * The id for the last message received from the user
 	 * @since 0.0.3
 	 */
 	public lastMessageID: string | null = null;
@@ -115,15 +115,15 @@ export class User<T = Client> extends Structure<T> {
 	}
 
 	/**
-	 * Returns the users username and discriminator.
+	 * Returns the user's username and discriminator.
 	 * @since 0.0.1
 	 */
 	public get tag(): string {
 		return `${this.username}#${this.discriminator}`;
 	}
 
 	/**
-	 * 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<T = Client> extends Structure<T> {
 	}
 
 	/**
-	 * 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<T = Client> extends Structure<T> {
 	}
 
 	/**
-	 * 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<T = Client> extends Structure<T> {
 	}
 
 	/**
-	 * Defines toString behavior for members.
+	 * Defines toString behavior for users.
 	 * @since 0.0.1
 	 */
 	public toString(): string {

src/lib/caching/structures/Webhook.ts

@@ -33,12 +33,12 @@ export class Webhook extends Structure<Client | WebhookClient> {
 	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<Client | WebhookClient> {
 	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<Client | WebhookClient> {
 	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<Client | WebhookClient> {
 	}
 
 	/**
-	 * 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<Client | WebhookClient> {
 	}
 
 	/**
-	 * Delete this webhook from the api
+	 * Delete the webhook from the api
 	 */
 	public async delete(): Promise<void> {
 		await (this.token ?

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

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;

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,8 +108,8 @@ 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
+	 * 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
 	 */
 	public permissionsFor(target: GuildMember | Role, guildScope = true): Readonly<Permissions> {
@@ -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

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;

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

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

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

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

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;