updated docs

Author: kvsxxx

README.md

@@ -65,7 +65,7 @@ from discord_ui import UI, SlashOption
 client = commands.Bot(" ")
 ui = UI(client)
 
-@ui.slash.command("hello_world", options=[SlashOption(bool, "cool", "whether this libary is cool", required=False)], guild_ids=["785567635802816595"])
+@ui.slash.command("hello_world", options=[SlashOption(bool, "cool", "whether this libary is cool", required=False)], guild_ids=[785567635802816595])
 async def command(ctx, cool=True):
     """This is a simple slash command"""
     # you can use docstrings for the slash command description too
@@ -83,7 +83,7 @@ from discurd_ui import UI
 client = commands.Bot(" ")
 ui = UI(client)
 
-@ui.slash.user_command("avatar", guild_ids=["785567635802816595"])
+@ui.slash.user_command("avatar", guild_ids=[785567635802816595])
 async def avatar(ctx, user: discord.Member):
     """Sends the avatar of a user"""
     await ctx.respond(embed=discord.Embed(description=user.display_name).set_image(url=user.avatar_url))

discord_ui/client.py

@@ -816,9 +816,9 @@ def command(self, name=MISSING, description=MISSING, options=[], guild_ids=MISSI
             @slash.command(name="hello_world", description="This is a test command", 
             options=[
                 SlashOption(str, name="parameter", description="this is a parameter", choices=[{ "name": "choice 1", "value": "test" }])
-            ], guild_ids=["785567635802816595"], default_permission=False, 
+            ], guild_ids=[785567635802816595], default_permission=False, 
             guild_permissions={
-                    "785567635802816595": SlashPermission(allowed={"539459006847254542": SlashPermission.USER})
+                    785567635802816595: SlashPermission(allowed={"539459006847254542": SlashPermission.USER})
                 }
             )
             async def command(ctx, parameter = None):
@@ -902,7 +902,7 @@ def subcommand(self, base_names, name=MISSING, description=MISSING, options=[],
 
             @slash.subcommand_group(base_names="hello", name="world", options=[
                 SlashOption(argument_type="user", name="user", description="the user to tell the holy words")
-            ], guild_ids=["785567635802816595"])
+            ], guild_ids=[785567635802816595])
             async def command(ctx, user):
                 ...
 
@@ -912,7 +912,7 @@ async def command(ctx, user):
 
             @slash.subcommand_group(base_names=["hello", "beautiful"], name="world", options=[
                 SlashOption(argument_type="user", name="user", description="the user to tell the holy words")
-            ], guild_ids=["785567635802816595"])
+            ], guild_ids=[785567635802816595])
             async def command(ctx, user):
                 ...
 
@@ -985,8 +985,8 @@ def user_command(self, name=MISSING, guild_ids=MISSING, default_permission=True,
         
         .. code-block::
 
-            @slash.user_command(name="call", guild_ids=["785567635802816595"], default_permission=False, guild_permissions={
-                "785567635802816595": SlashPermission(allowed={
+            @slash.user_command(name="call", guild_ids=[785567635802816595], default_permission=False, guild_permissions={
+                785567635802816595: SlashPermission(allowed={
                     "585567635802816595": SlashPermission.USER
                 })
             })
@@ -1031,8 +1031,8 @@ def message_command(self, name=MISSING, guild_ids=MISSING, default_permission=Tr
         
         .. code-block::
 
-            @slash.message_command(name="quote", guild_ids=["785567635802816595"], default_permission=False, guild_permissions={
-                "785567635802816595": SlashPermission(allowed={
+            @slash.message_command(name="quote", guild_ids=[785567635802816595], default_permission=False, guild_permissions={
+                785567635802816595: SlashPermission(allowed={
                     "585567635802816595": SlashPermission.USER
                 })
             })

discord_ui/cogs.py

@@ -352,9 +352,9 @@ class My_Cog(commands.Cog)
 
             @slash_cog(name="hello_world", options=[
                 SlashOption(str, name="parameter", description="this is a parameter", choices=[{ "name": "choice 1", "value": "test" }])
-            ], guild_ids=["785567635802816595"], default_permission=False, 
+            ], guild_ids=[785567635802816595], default_permission=False, 
             guild_permissions={
-                    "785567635802816595": SlashPermission(allowed={"539459006847254542": SlashPermission.USER})
+                    785567635802816595: SlashPermission(allowed={"539459006847254542": SlashPermission.USER})
                 }
             )
             async def hello_world(self, ctx, parameter = None):
@@ -420,7 +420,7 @@ class My_Cog(commands.Cog):
 
             @subslash_cog(base_names="hello", name="world", options=[
                 SlashOption(argument_type="user", name="user", description="the user to tell the holy words")
-            ], guild_ids=["785567635802816595"])
+            ], guild_ids=[785567635802816595])
             async def command(ctx, user):
                 ...
 
@@ -433,7 +433,7 @@ class My_Cog(commands.Cog):
 
             @subslash_cog(base_names=["hello", "beautiful"], name="world", options=[
                 SlashOption(argument_type="user", name="user", description="the user to tell the holy words")
-            ], guild_ids=["785567635802816595"])
+            ], guild_ids=[785567635802816595])
             async def command(ctx, user):
                 ...
 
@@ -483,7 +483,7 @@ class My_Cog(commands.Cog):
                 ...
 
                 # message command
-                @context_cog(type="message", name="quote", guild_ids=["785567635802816595"])
+                @context_cog(type="message", name="quote", guild_ids=[785567635802816595])
                 async def quote(ctx, message):
                     ...
                 

discord_ui/slash/types.py

@@ -388,9 +388,9 @@ async def my_function(command, parameter=None):
         SlashCommand(callback=my_function, name="hello_world", description="This is a test command", 
             options=[
                 SlashOption(str, name="parameter", description="this is a parameter", choices=[{ "name": "choice 1", "value": 1 }])
-            ], guild_ids=["785567635802816595"], default_permission=False, 
+            ], guild_ids=[785567635802816595], default_permission=False, 
             guild_permissions={ 
-                "785567635802816595": SlashPermission(allowed={"539459006847254542": SlashPermission.USER}) 
+                785567635802816595: SlashPermission(allowed={"539459006847254542": SlashPermission.USER}) 
             })
         ```
         """

docs/source/usage.rst

@@ -307,7 +307,7 @@ It acceps a list of :class:`~SlashOption`
 
     @ui.slash.command(name="test", description="this is a test command", options=[
             SlashOption(int, name="parameter1", description="this is a parameter")
-        ], guild_ids=["785567635802816595"])
+        ], guild_ids=[785567635802816595])
     async def command(ctx, parameter1="nothing"):
         await ctx.respond("I got `" + str(parameter1) + "` for `parameter1`")
 
@@ -344,17 +344,13 @@ If you want the parameter to be required, in the option, you have to set ``requi
 
     @ui.slash.command(name="test", description="this is a test command", options=[
             SlashOption(int, name="parameter1", description="this is a parameter", required=True)
-        ], guild_ids=["785567635802816595"])
+        ], guild_ids=[785567635802816595])
     async def command(ctx, parameter1):
         await ctx.respond("I got `" + str(parameter1) + "` for `parameter1`")
 
 .. image:: images/slash/test_param_options_required.gif
     :width: 550
 
-.. note::
-
-    the ``parameter`` argument of the callback function doesn't have a default value anymore, 
-    because if the command is used, it will always get a value passed
 
 Choices
 ~~~~~~~~~~
@@ -370,13 +366,28 @@ Too add them, where we add the options with the :class:`~SlashOption` class, we
                 SlashOption(int, name="parameter1", description="this is a parameter", choices=[
                     {"name": "first choice", "value": 1}, {"name": "second choice", "value": 2}
                 ])
-            ], guild_ids=["785567635802816595"])
+            ], guild_ids=[785567635802816595])
     async def command(ctx, parameter1="nothing"):
         await ctx.respond("I got `" + str(parameter1) + "` for `parameter1`")
 
 Choices are a list of dict, where ``"name":`` is the displayed choice name and ``"value":`` is the real value, 
 which will be received when the choice is selected 
 
+You can also use the ``create_choice`` function to make it easier
+
+.. code-block::
+
+    from discord_ui import create_choice
+    ...
+
+    @ui.slash.command(name="test", description="this is a test command", options=[
+                SlashOption(int, name="parameter1", description="this is a parameter", choices=[
+                    create_choice("first choice", 1), create_choice("second choice", 2)
+                ])
+            ], guild_ids=[785567635802816595])
+    async def command(ctx, parameter1="nothing"):
+        await ctx.respond("I got `" + str(parameter1) + "` for `parameter1`")
+
 .. image:: images/slash/test_param_choices.gif
     :width: 550
 
@@ -402,7 +413,7 @@ If the default permission to ``False``, no one can use the command, if it's ``Tr
 
     @ui.slash.command(name="test", description="this is a test command", options=[
             SlashOption(int, name="parameter1", description="this is a parameter")
-        ], guild_ids=["785567635802816595"], default_permission=False)
+        ], guild_ids=[785567635802816595], default_permission=False)
     async def command(ctx, parameter1="nothing"):
         ...
 
@@ -420,8 +431,8 @@ You can add role ids or/and user ids
 
     @ui.slash.command(name="test", description="this is a test command", options=[
             SlashOption(int, name="parameter1", description="this is a parameter")
-        ], guild_ids=["785567635802816595"], guild_permissions={
-        "785567635802816595": SlashPermission(
+        ], guild_ids=[785567635802816595], guild_permissions={
+        785567635802816595: SlashPermission(
             allowed={ 
                 "539459006847254542": SlashPermission.USER,
                 "849035012476895232": SlashPermission.ROLE
@@ -444,6 +455,9 @@ Forbidden command
     :width: 1000
 
 
+You can later update the command permissions with the :meth:`~Slash.update_permissions` function. 
+
+
 guild ids
 ~~~~~~~~~~~
 
@@ -453,7 +467,7 @@ To set the guilds where the command is useable, you need to set the ``guild_id``
 
 .. code-block::
 
-    @ui.slash.command(name="test", description="this is a test command", guild_ids=["785567635802816595"])
+    @ui.slash.command(name="test", description="this is a test command", guild_ids=[785567635802816595])
     async def command(ctx, parameter1="nothing"):
         ...
 

examples/calculator.py

@@ -30,7 +30,7 @@
 
 
 # Create a slash command
-@ui.slash.command(name="calculator", description="opens a calculator, that will automatically close when no input was provided after 20 seconds", guild_ids=["785567635802816595"])
+@ui.slash.command(name="calculator", description="opens a calculator, that will automatically close when no input was provided after 20 seconds", guild_ids=[785567635802816595])
 async def test(ctx: SlashedCommand):
     # The current query for the calculator
     query = ""

examples/context_commands.py

@@ -18,7 +18,7 @@
 
 
 # Create the command
-@ui.slash.message_command("quote", ["785567635802816595"])
+@ui.slash.message_command("quote", [785567635802816595])
 # register the callback
 async def quote(ctx, message):
     # respond to the interaction so no error will show up
@@ -31,7 +31,7 @@ async def quote(ctx, message):
     await webhook.delete()
 
 # Create the command
-@ui.slash.user_command("avatar", ["785567635802816595"])
+@ui.slash.user_command("avatar", [785567635802816595])
 # register the callback
 async def avatar(ctx, user):
     # send a embed with the user's avatar

examples/generate_linkbutton.py

@@ -28,7 +28,7 @@
         SlashOption(str, "emoji", "a emoji appearing before the text")
     ], 
     # If you want to test the command, use guild_ids, because this is way faster than global commands
-    guild_ids=["785567635802816595"])
+    guild_ids=[785567635802816595])
 async def command(ctx, message_content="cool, right?", name="click me", link="https://github.com/discord-py-ui/discord-ui", emoji=None):
     # Check if the link is valid
     if not link.startswith("http://") and not link.startswith("https://"):

examples/role_picker.py

@@ -22,7 +22,7 @@
 ui = UI(client, slash_options={"wait_sync": 2, "delete_unused": True})
 
 # Create a slash command
-@ui.slash.command(name="role-picker", description="let's you pick roles", guild_ids=["785567635802816595"])
+@ui.slash.command(name="role-picker", description="let's you pick roles", guild_ids=[785567635802816595])
 async def command(ctx: SlashedCommand):
 
     # The role picker component