feat: Added an explanation on reactions #55
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
shiftinv
added
t: page/section addition
shiftinv
requested changes
Jan 6, 2023
There was a problem hiding this comment.
Nice! I quite like the fact that the different emoji types are also explained, as well as the usage of raw events.
I've left a bunch of (mostly tiny) comments/suggestions - I tried to cleanly separate them, so it may seem more than it actually is. Hope I wasn't too pedantic :>
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
These are good suggestions Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
Merged the suggesions from Shiftinv and took their comments into consideration and made some alterations
shiftinv
reviewed
Jan 7, 2023
LGTM Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
shiftinv
reviewed
Jan 7, 2023
Co-authored-by: shiftinv <[email protected]> Signed-off-by: Strix <[email protected]>
Fixed some straggling spelling errors
| @@ -1,8 +1,314 @@ | |||
| --- | |||
| description: Create polls, paginate your commands, and more. | |||
| description: This section covers the topic of interacting with message reactions. Both adding them with code, and reacting to on_reaction events | |||
| hide_table_of_contents: true | |||
There was a problem hiding this comment.
The TOC will be visible on non-WIP pages.
Suggested change
| hide_table_of_contents: true |
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.
Description
The guide has several pages that are currently WIP.
I took the liberty to flesh out the Reactions portion.
Am a bit unsure how to target the guide however. Reactions and its usage is somewhat basic knowledge,
and very easy to glean usage from the api docs.
Therefore i took the approach that the person reading would be quite entry level with python.
This means explaining things that might seem obvious and using a lot of comments in the code snippet.
It mainly covers the
on_raw_reactionevents since they are probably the most useful.But included a
MessageCommandexample to demonstrate working with the Reaction class since its kind of the main focus.Truth be told there's not really that much to be said about Reactions, so added things i found useful when working with reactions on my projects.
Also includes a brief primer on how Emojis work seeing as they're pretty integral to Reactions and knowing how they are supplied is important to filter events correctly.
Includes links to other parts of the guide and github to reduce repeating information that needs to be maintained and agree with each other.