docs: Refactor a few @returns
descriptions
#6228
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please describe the changes this PR makes and why it should be merged:
This pull request tweaks some
@returns
descriptions that I have judged... strange.When I was looking through the documentation for a
GuildEmoji
, I noticed theGuildEmoji#equals()
method had a@returns
description on it. I also noticed the description is quite literally the same as the initial description. So like, why is it there? This is the same forSticker#equals()
, but there does not appear to be a@returns
description for otherequal()
methods around discord.js such asUser#equals()
orRole#equals()
. I went ahead and removed the two instances that had@returns
descriptions for also the sake of being consistent.TextChannel#createWebhook()
had a@returns
description of "webhook The created webhook". Obviously the first word shouldn't be there, but I altered this nonetheless to "Returns the created Webhook" to provide a better feedback description.I also saw
TextChannel#bulkDelete()
just say "Deleted messages", so I thought it would be better to provide a better feedback description here also.Status and versioning classification: