Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Refactor a few @returns descriptions #6228

Merged
merged 3 commits into from
Jul 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/structures/GuildEmoji.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ class GuildEmoji extends BaseGuildEmoji {
/**
* Whether this emoji is the same as another one.
* @param {GuildEmoji|APIEmoji} other The emoji to compare it to
* @returns {boolean} Whether the emoji is equal to the given emoji or not
* @returns {boolean}
*/
equals(other) {
if (other instanceof GuildEmoji) {
Expand Down
2 changes: 1 addition & 1 deletion src/structures/Sticker.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ class Sticker extends Base {
/**
* Whether this sticker is the same as another one.
* @param {Sticker|APISticker} other The sticker to compare it to
* @returns {boolean} Whether the sticker is equal to the given sticker or not
* @returns {boolean}
*/
equals(other) {
if (other instanceof Sticker) {
Expand Down
2 changes: 1 addition & 1 deletion src/structures/TextChannel.js
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ class TextChannel extends GuildChannel {
* Creates a webhook for the channel.
* @param {string} name The name of the webhook
* @param {ChannelWebhookCreateOptions} [options] Options for creating the webhook
* @returns {Promise<Webhook>} webhook The created webhook
* @returns {Promise<Webhook>} Returns the created Webhook
* @example
* // Create a webhook for the current channel
* channel.createWebhook('Snek', {
Expand Down
2 changes: 1 addition & 1 deletion src/structures/interfaces/TextBasedChannel.js
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ class TextBasedChannel {
* @param {Collection<Snowflake, Message>|MessageResolvable[]|number} messages
* Messages or number of messages to delete
* @param {boolean} [filterOld=false] Filter messages to remove those which are older than two weeks automatically
* @returns {Promise<Collection<Snowflake, Message>>} Deleted messages
* @returns {Promise<Collection<Snowflake, Message>>} Returns the deleted messages
* @example
* // Bulk delete messages
* channel.bulkDelete(5)
Expand Down