Skip to content

Commit 5ddbd4f

Browse files
authored
Merge pull request #289 from goverfl0w/master
Fix slight doc formatting issues.
2 parents 228ebb5 + 8dc2e52 commit 5ddbd4f

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/gettingstarted.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,8 @@ Adding Context Menus.
319319
*********************
320320
Lucky for you, this library has recently added support for context menus! Let's take a look into how they're designed.
321321

322+
Please note that the current limit for context menus with the Discord API is **5.**
323+
322324
A menu command (context menu) is an easy way for bot developers to program optionless and choiceless commands into their bot
323325
which can be easily accessible by right clicking on a user and/or message present. Below is a table of the supported keys and
324326
values:
@@ -340,7 +342,7 @@ The following table below represents how it would be shown as a JSON object:
340342
"type": 3
341343
}
342344
343-
The following table explains more about the `type` parameter being passed, which there are three of: `CHAT_INPUT`, `USER` and `MESSAGE`. By default, the type will
345+
The following table explains more about the ``type`` parameter being passed, which there are three of: ``CHAT_INPUT``, ``USER`` and ``MESSAGE``. By default, the type will
344346
always be the first. This is because it is a registered type that is used to process slash commands, and should not be used for when you are declaring context menu
345347
commands in your bot's code at all:
346348

@@ -354,7 +356,7 @@ commands in your bot's code at all:
354356
| MESSAGE | 3 |
355357
+------------+-----------+
356358

357-
Unlike `manage_commands` and `manage_components`, you will have to use a decorator for now to register them:
359+
Unlike ``manage_commands`` and ``manage_components``, you will have to use a decorator for now to register them:
358360

359361
.. code-block :: python
360362
@@ -370,12 +372,12 @@ Unlike `manage_commands` and `manage_components`, you will have to use a decorat
370372
hidden=True
371373
)
372374
373-
The `@slash.context_menu` decorator takes in the context type as given (to either appear when you right-click on a user or when you right-click on a message) as well
375+
The ``@slash.context_menu`` decorator takes in the context type as given (to either appear when you right-click on a user or when you right-click on a message) as well
374376
as the name of the command, and any guild IDs if given if you would like to make it applicable to only a guild. **We only accept connected names** for the time being,
375377
although context menus will have the ability to have spaces in their name in the future when development further progresses.
376378

377-
You are able to also use the `@cog_ext.cog_context_menu` path which will require an import from `cog_ext.py` respectively, however, it is worth nothing that
378-
the `target` kwarg for the decorator **must** be brought to the very end.
379+
You are able to also use the ``@cog_ext.cog_context_menu`` path which will require an import from ``cog_ext.py`` respectively, however, it is worth nothing that
380+
the ``target`` kwarg for the decorator **must** be brought to the very end.
379381

380382
Can I use components with context menus?
381383
----------------------------------------
@@ -405,4 +407,4 @@ for explicitly context menus, as they're more universal.
405407
.. _ApplicationCommandOptionChoice: https://discord.com/developers/docs/interactions/slash-commands#applicationcommandoptionchoice
406408
.. _ApplicationCommandOption: https://discord.com/developers/docs/interactions/slash-commands#applicationcommandoption
407409
.. _ApplicationCommandPermissionType: https://discord.com/developers/docs/interactions/slash-commands#applicationcommandpermissions
408-
.. _ApplicationCommandType: https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types
410+
.. _ApplicationCommandType: https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types

0 commit comments

Comments
 (0)