feat: Added an explanation on reactions by Strixen · Pull Request #55 · DisnakeDev/guide

Strixen · 2023-01-06T15:55:03Z

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_reaction events since they are probably the most useful.
But included a MessageCommand example 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.

shiftinv

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 <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

These are good suggestions Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Merged the suggesions from Shiftinv and took their comments into consideration and made some alterations

LGTM Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

shiftinv

A few more formatting comments. I think that's everything now, thanks for enduring my comments so far 🙏

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

shiftinv

forgot to approve, my bad

Fixed some straggling spelling errors

abhigyantrips

Agree with the content so far. Can you also create corresponding files under the examples/ directory? The location convention is a part of the contributing guide.

abhigyantrips · 2023-03-25T11:15:30Z

 ---
-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


The TOC will be visible on non-WIP pages.
Suggested change
hide_table_of_contents: true

feat: Added an explanation on reactions
cb17252

shiftinv added t: page/section addition Pull Request to add new content to the guide. s: needs review labels Jan 6, 2023

shiftinv requested changes Jan 6, 2023
View reviewed changes

Strixenand others added 7 commits January 7, 2023 07:53

Merge branch 'dev' into dev
611b8c1

Update guide/docs/popular-topics/reactions.mdx
9c219f4
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Update guide/docs/popular-topics/reactions.mdx
265d1ce
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Update guide/docs/popular-topics/reactions.mdx
2b7506f
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Update guide/docs/popular-topics/reactions.mdx
6a39a2e
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Apply suggestions from code review
c210d39
These are good suggestions Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

Response to Reviews on PRDisnakeDev#55
337719e
Merged the suggesions from Shiftinv and took their comments into consideration and made some alterations

shiftinv reviewed Jan 7, 2023
View reviewed changes

Comment threadguide/docs/popular-topics/reactions.mdx Outdated
Comment threadguide/docs/popular-topics/reactions.mdx Outdated
Comment threadguide/docs/popular-topics/reactions.mdx Outdated
Comment threadguide/docs/popular-topics/reactions.mdx Outdated

Apply suggestions from code review
031502c
LGTM Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

shiftinv reviewed Jan 7, 2023
View reviewed changes

Apply suggestions from code review
dff3399
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: Strix <thomhod@gmail.com>

shiftinv requested a review from abhigyantrips January 8, 2023 14:41

shiftinv changed the base branch from dev to mainJanuary 8, 2023 14:54

shiftinv approved these changes Jan 18, 2023
View reviewed changes

Strixen force-pushed the dev branch from 613b7f6 to dff3399Compare February 12, 2023 12:49

Spell-Checks
6d79e1a
Fixed some straggling spelling errors

abhigyantrips reviewed Mar 25, 2023
View reviewed changes

Uh oh!

Conversation

Strixen commented Jan 6, 2023

Description

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

abhigyantrips left a comment

Choose a reason for hiding this comment

Uh oh!

abhigyantripsMar 25, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants