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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

fix(Message): update typings and docs related to #edit #5745

Merged
merged 4 commits into from Jun 3, 2021
Merged

fix(Message): update typings and docs related to #edit #5745

merged 4 commits into from Jun 3, 2021

Conversation

iShibi
Copy link
Contributor

@iShibi iShibi commented Jun 3, 2021 •
edited

Please describe the changes this PR makes and why it should be merged:

This PR fixes the following:

  1. The jsdoc of Message#edit doesn't show content can be null
  2. Message#edit can take MessageAttachment or array of it in options
  3. The content field in MesssageEditOptions can be null
  4. The jsdoc of MessageEditOptions doesn't show content can be null

Thanks X 3, @ToasterSticks for noticing this issue too 馃憤

Status and versioning classification:

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating
  • This PR changes the library's interface (methods or parameters added)

vaporoxx
vaporoxx reviewed Jun 3, 2021
View reviewed changes
Copy link
Contributor

@vaporoxx vaporoxx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what case would you want to do message.edit(null); though?

src/structures/Message.js Outdated Show resolved Hide resolved
src/structures/Message.js Outdated Show resolved Hide resolved
iShibi and others added 2 commits June 3, 2021 21:19
@iShibi @vaporoxx
docs(MessageEditOptions): use ? instead of null for content
f5ff348 
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>
@iShibi @vaporoxx
docs(Message#edit): use ? instead of explicit null for content param
147b991 
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>
@iCrawl iCrawl merged commit a2f0c11 into discordjs:master Jun 3, 2021
@iShibi iShibi deleted the fix-msg-edit branch June 15, 2021 15:01
@iCrawl iCrawl added this to the Version 13 milestone Jun 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vaporoxx vaporoxx vaporoxx left review comments

@iCrawl iCrawl iCrawl approved these changes

@kyranet kyranet kyranet approved these changes

@SpaceEEC SpaceEEC SpaceEEC approved these changes

@vladfrangu vladfrangu Awaiting requested review from vladfrangu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Version 13
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@iShibi @iCrawl @kyranet @SpaceEEC @vaporoxx