Add EmbedField object to allow for easier embed class instance creation
#1181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krittick
added
priority: low
|
|
Dorukyum
previously requested changes
Mar 18, 2022
That's my plan as part of this PR, just haven't gotten there yet. |
Dorukyum
reviewed
Mar 23, 2022
fix typing for fields parameter in Embed.__init__ fix typing for Embed.fields property change Embed.add_field, Embed.insert_field_at to use an EmbedField object when appending to Embed._fields change Embed.set_field_at to set EmbedField properties instead of dictionary values
krittick
added
status: awaiting review
|
This is now ready for review. |
EmreTech
previously approved these changes
Apr 9, 2022
7 tasks
Lulalaby
previously approved these changes
Apr 11, 2022
Lulalaby
previously approved these changes
Apr 12, 2022
Dorukyum
reviewed
Apr 17, 2022
Dorukyum
previously requested changes
Apr 17, 2022
Dorukyum
approved these changes
Apr 17, 2022
Lulalaby
approved these changes
Apr 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This adds a new object
EmbedField, which corresponds to the object of the same name in the API Documentation. This also follows the same conventions used by other libraries (i.e. treating EmbedField as a higher level object), such as discord.js, DisCatSharp, and many others.A parameter
fieldshas also been added to the__init__method for theEmbedclass, which allows passing a list ofEmbedFieldobjects when creating a new embed, instead of needing to useEmbed.add_field()for each field. It also adds a setter for thefieldsproperty which accomplishes the same thing for existing embeds.This is a breaking change only if you were somehow using the private
_EmbedFieldProxyclass for anything, as this has now been removed in favor ofEmbedField.Checklist
type: ignorecomments were used, a comment is also left explaining why