Context menu, checks, and cooldowns guide #7952

Aryathel · 2022-04-29T11:38:25Z

Summary

Updating the Context Menus guide (Just something I threw together as it is already being worked on by another as well).
I plan to also specifically add an app_commands.checks guide, which will include information on cooldowns.

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

Aryathel · 2022-04-30T02:18:18Z

Added the checks guide, which includes the information on cooldowns. This guide is specifically for AppCommand checks, as there are differences from standard checks. Not sure if it deserves its own page, but the document is written up now and can be put wherever later.

GoogolGenius

Great job!

docs/interactions/checks.rst

Co-authored-by: GoogleGenius <[email protected]>

Aryathel · 2022-06-08T02:29:20Z

Great job!

Thanks for catching stuff I missed!

No767 · 2023-09-11T06:14:43Z

Just did a quick scan of this PR. Global interaction checks are not documented yet, which I will probably do in a bit

IAmTomahawkx

The guide itself looks pretty good, however the rst files need to be moved into a guide folder, eg /docs/guide/interactions/.

docs/interactions/context_menus.rst

docs/interactions/checks.rst

docs/interactions/context_menus.rst

docs/interactions/checks.rst

docs/interactions/context_menus.rst

Soheab · 2023-09-11T06:58:22Z

~~This is missing the integration "checks" (default_permissions, nsfw, guild_only, etc).~~ did this as a comment for some reason lol but they have been added.

docs/guide/interactions/checks.rst

No767

This will probably the last of suggestions i'll do for this pr. once all of the suggestions and edits have been made, you can probably request the final review for danny and that should be it

docs/guide/interactions/checks.rst

docs/guide/interactions/context_menus.rst

docs/guide/interactions/checks.rst

Co-authored-by: Willy <[email protected]> Co-authored-by: Noelle Wang <[email protected]>

IAmTomahawkx

LGTM

No767

LGTM as well

Gobot1234

Not entirely sure about owner_only things being for guild owners only but aside from that, some weird line wrapping and my wording nits looks good

docs/guide/interactions/checks.rst

docs/guide/interactions/context_menus.rst

Gobot1234 · 2023-09-14T22:34:14Z

docs/guide/interactions/context_menus.rst

+
+- Context menus can be triggered from two possible sources: by right clicking on a user or server member, or by right clicking on a message.
+- The ``name`` argument of the :func:`@context_menu <.app_commands.context_menu>` decorator defines the command name that appears in the context menu.
+- The second argument can be of type :class:`.User`, :class:`.Member`, or :class:`.User` | :class:`.Member` for user context menus.


It's not obvious to me reading this what the distinction between User, Member or User | Member is, should this not just be User or Member and drop the union at the end?

I'm not sure how to specify this one honestly.

To my knowledge, when used in a Guild context, the arg will be a Member, and when used in a DM context, it will be a User. However, you can also get a User object for both Guild and DMs, or use the union to get either one respective to what environment you invoke the command/menu in.

Ah right, makes a bit more sense now, not sure if there's a better way to put this, I'll leave that to someone else

docs/guide/interactions/context_menus.rst

@Gobot1234

Added most of the review suggestions from @Gobot1234 Co-authored-by: James Hilton-Balfe <[email protected]>

Gobot1234 · 2023-09-21T16:30:49Z

docs/guide/interactions/checks.rst

+    @app_commands.context_menu(name='User Context')
+    @app_commands.default_permissions(manage_messages=True, manage_guild=True)
+    async def default_permissions_slash_command(interaction: discord.Interaction, user: discord.User) -> None:
+        await interaction.response.send_message('You may or may not have those permissions!'


Suggested change

await interaction.response.send_message('You may or may not have those permissions!'

await interaction.response.send_message('You may or may not have those permissions!')

redgoldlace and others added 5 commits March 5, 2022 20:16

Respect the alignment specified by the image directive

007ab7c

Added context_menus.rst

9df753c

Add images

094af97

Added context_menus.rst

a9d6e5a

Fixed checks syntax

d25cd55

Rapptz added the guide This relates to the discord.py guide label Apr 29, 2022

Aryathel added 2 commits April 29, 2022 17:39

Updated typos, moved checks guide to separate page.

ac2c81a

Add checks guide

c6e8da2

Aryathel marked this pull request as ready for review April 30, 2022 02:20

Aryathel changed the title ~~[WIP] Context menu, checks, and cooldowns guide~~ Context menu, checks, and cooldowns guide Apr 30, 2022

GoogolGenius suggested changes Jun 7, 2022

View reviewed changes

docs/interactions/checks.rst Outdated Show resolved Hide resolved

docs/interactions/checks.rst Outdated Show resolved Hide resolved

docs/interactions/checks.rst Outdated Show resolved Hide resolved

docs/interactions/checks.rst Outdated Show resolved Hide resolved

Aryathel and others added 4 commits June 7, 2022 19:28

Whitespace fix

fa8af01

Co-authored-by: GoogleGenius <[email protected]>

Grammar update

5803e4f

Co-authored-by: GoogleGenius <[email protected]>

Typo fix

b0f2a27

Co-authored-by: GoogleGenius <[email protected]>

Typo fix

2167458

Co-authored-by: GoogleGenius <[email protected]>

Rapptz force-pushed the docs/guide branch from 007ab7c to a2b09c0 Compare February 11, 2023 23:44

Merge branch 'Rapptz:docs/guide' into docs/guide

687ced1

IAmTomahawkx suggested changes Sep 11, 2023

View reviewed changes

Aryathel added 4 commits September 11, 2023 00:10

Added orphan tag and started updating grammatical fixes.

c916713

Updated some wording and content structure

7f2bae7

Added global interaction check section

76aa478

Added links to other guides

0c4fc1e

No767 reviewed Sep 11, 2023

View reviewed changes

docs/guide/interactions/checks.rst Show resolved Hide resolved

Added integration permission guide to checks guide

d891a48

No767 suggested changes Sep 12, 2023

View reviewed changes

docs/guide/interactions/checks.rst Outdated Show resolved Hide resolved

No767 suggested changes Sep 12, 2023

View reviewed changes

docs/guide/interactions/checks.rst Outdated Show resolved Hide resolved

docs/guide/interactions/checks.rst Outdated Show resolved Hide resolved

docs/guide/interactions/context_menus.rst Show resolved Hide resolved

Willy-C suggested changes Sep 12, 2023

View reviewed changes

docs/guide/interactions/checks.rst Outdated Show resolved Hide resolved

docs/guide/interactions/checks.rst Outdated Show resolved Hide resolved

Aryathel and others added 2 commits September 13, 2023 13:57

Apply suggestions from code review

79ba186

Co-authored-by: Willy <[email protected]> Co-authored-by: Noelle Wang <[email protected]>

Example syntax update and context menu details

edf1c16

IAmTomahawkx approved these changes Sep 13, 2023

View reviewed changes

No767 approved these changes Sep 14, 2023

View reviewed changes

Gobot1234 reviewed Sep 14, 2023

View reviewed changes

Aryathel and others added 3 commits September 14, 2023 15:51

Apply suggestions from code review

28de928

Added most of the review suggestions from @Gobot1234 Co-authored-by: James Hilton-Balfe <[email protected]>

Apply suggestions from code review

27ab440

Apply suggestions from code review

a094f34

Gobot1234 reviewed Sep 21, 2023

View reviewed changes

No767 mentioned this pull request Sep 29, 2023

[docs] app commands guide #9557

Draft

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Context menu, checks, and cooldowns guide #7952

Context menu, checks, and cooldowns guide #7952

Aryathel commented Apr 29, 2022 •

edited

Loading

Aryathel commented Apr 30, 2022

GoogolGenius left a comment

Aryathel commented Jun 8, 2022

No767 commented Sep 11, 2023

IAmTomahawkx left a comment

Soheab commented Sep 11, 2023 •

edited

Loading

No767 left a comment

IAmTomahawkx left a comment

No767 left a comment

Gobot1234 left a comment

Gobot1234 Sep 14, 2023 •

edited

Loading

Aryathel Sep 14, 2023

Gobot1234 Sep 14, 2023

Gobot1234 Sep 21, 2023

	await interaction.response.send_message('You may or may not have those permissions!'
	await interaction.response.send_message('You may or may not have those permissions!')

Context menu, checks, and cooldowns guide #7952

Are you sure you want to change the base?

Context menu, checks, and cooldowns guide #7952

Conversation

Aryathel commented Apr 29, 2022 • edited Loading

Summary

Checklist

Aryathel commented Apr 30, 2022

GoogolGenius left a comment

Choose a reason for hiding this comment

Aryathel commented Jun 8, 2022

No767 commented Sep 11, 2023

IAmTomahawkx left a comment

Choose a reason for hiding this comment

Soheab commented Sep 11, 2023 • edited Loading

No767 left a comment

Choose a reason for hiding this comment

IAmTomahawkx left a comment

Choose a reason for hiding this comment

No767 left a comment

Choose a reason for hiding this comment

Gobot1234 left a comment

Choose a reason for hiding this comment

Gobot1234 Sep 14, 2023 • edited Loading

Choose a reason for hiding this comment

Aryathel Sep 14, 2023

Choose a reason for hiding this comment

Gobot1234 Sep 14, 2023

Choose a reason for hiding this comment

Gobot1234 Sep 21, 2023

Choose a reason for hiding this comment

Aryathel commented Apr 29, 2022 •

edited

Loading

Soheab commented Sep 11, 2023 •

edited

Loading

Gobot1234 Sep 14, 2023 •

edited

Loading