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(MessageEmbed): deprecation advisory for type #5774

Merged
merged 4 commits into from
Jun 10, 2021
Merged

docs(MessageEmbed): deprecation advisory for type #5774

merged 4 commits into from
Jun 10, 2021

Conversation

MidSpike
Copy link
Contributor

@MidSpike MidSpike commented Jun 6, 2021

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

  • After reading Discord's Documentation for Embeds, I noticed that they recommend for developers to treat Embed.type as deprecated. I have updated the documentation to reflect that.
  • Added <warn>Discord advises that "Embed types should be considered deprecated and might be removed in a future API version."</warn> for MessageEmbed.type
  • Added @deprecated for MessageEmbed.type

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 only includes non-code changes, like changes to documentation, README, etc.

After reading [the Discord Docs](https://discord.com/developers/docs/resources/channel#embed-object-embed-types) I noticed that they recommend for developers to treat `Embed.type` as deprecated.
I have updated the docs to reflect that.
integrated suggested edit

Co-authored-by: DTrombett <73136330+DTrombett@users.noreply.github.com>
Copy link
Member

@kyranet kyranet left a comment

Choose a reason for hiding this comment

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

Even if we usually don't do this, could you add /** @deprecated */ in the typings?

cc: @iCrawl @vladfrangu

@iCrawl
Copy link
Member

iCrawl commented Jun 7, 2021

If its deprecated, why keep it at all and not just remove it like we do in #5766?

@vladfrangu
Copy link
Member

Well, it could be deprecated for a day or a century, nobody knows... Honestly, we should mark it as deprecated, and remove it when Discord does it 👍

@iCrawl iCrawl changed the title Added deprecation advisory for MessageEmbed.type docs(MessageEmbed): deprecation advisory for type Jun 10, 2021
@iCrawl iCrawl merged commit f5f3f77 into discordjs:master Jun 10, 2021
@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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants