docs: improved docstrings in roleinfo

This commit is contained in:
Seaswimmer 2023-08-08 21:44:13 -04:00
parent a7ec04870e
commit 0e7a4a25eb
No known key found for this signature in database
GPG key ID: 5019678FD9CF50D8

View file

@ -505,8 +505,15 @@ class Info(commands.Cog):
@app_commands.command() @app_commands.command()
@app_commands.guild_only() @app_commands.guild_only()
async def roleinfo(self, interaction: discord.Interaction, role: discord.Role, list_permissions: bool = False): async def roleinfo(self, interaction: discord.Interaction, role: discord.Role, list_permissions: bool = False):
"""Gives information on a specific role. """Gives information on a given role.
`list_permissions` is ignored if the role you're checking has the `Administrator` permission."""
Parameters
-----------
role: discord.Role
The role you're checking
list_permissions: bool
Whether or not to list permissions. Ignored if the role has Administrator.
"""
try: try:
icon = role.display_icon icon = role.display_icon
if isinstance(icon, discord.Asset): if isinstance(icon, discord.Asset):