mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-10-25 10:32:59 +00:00
Code Issues Projects Releases Wiki Activity

Document that docstrings can be used to document parameters

Browse Source
This commit is contained in:
Bluesy
2022-08-16 14:00:09 -07:00
committed by GitHub
parent 5039b967a0
commit 288f2d169e
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
discord/app_commands/commands.py
View File

@@ -2094,6 +2094,23 @@ def describe(**parameters: Union[str, locale_str]) -> Callable[[T], T]:
async def ban(interaction: discord.Interaction, member: discord.Member): async def ban(interaction: discord.Interaction, member: discord.Member):
await interaction.response.send_message(f'Banned {member}') await interaction.response.send_message(f'Banned {member}')
Alternatively, you can describe parameters using Google, Sphinx, or Numpy style docstrings.
Example:
.. code-block:: python3
@app_commands.command()
async def ban(interaction: discord.Interaction, member: discord.Member):
\"\"\"Bans a member
Parameters
-----------
member: discord.Member
the member to ban
\"\"\"
await interaction.response.send_message(f'Banned {member}')
Parameters Parameters
----------- -----------
\*\*parameters: Union[:class:`str`, :class:`locale_str`] \*\*parameters: Union[:class:`str`, :class:`locale_str`]