Skip to content

Commit

Permalink
Add provisional API notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackenmen committed Mar 17, 2024
1 parent 26eb980 commit b15fc0e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
12 changes: 12 additions & 0 deletions redbot/core/utils/menus.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,12 @@ async def menu(
This parameter should be the 7th one, and none of the
parameters in the handling functions are optional.
.. warning::
The ``user`` parameter is considered provisional.
If no issues arise, we plan on including it under developer guarantees
in the first release made after 2024-05-18.
.. warning::
If you're using the ``user`` param, you need to pass it
Expand Down Expand Up @@ -158,6 +164,12 @@ async def control_no(*args, **kwargs):
user: Optional[discord.User]
The user allowed to interact with the menu. Defaults to ``ctx.author``.
.. warning::
This parameter is provisional.
If no issues arise, we plan on including it under developer guarantees
in the first release made after 2024-05-18.
Raises
------
RuntimeError
Expand Down
12 changes: 12 additions & 0 deletions redbot/core/utils/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,13 +245,25 @@ async def start(
"""
Used to start the menu displaying the first page requested.
.. warning::
The ``user`` parameter is considered provisional.
If no issues arise, we plan on including it under developer guarantees
in the first release made after 2024-05-18.
Parameters
----------
ctx: `commands.Context`
The context to start the menu in.
user: discord.User
The user allowed to interact with the menu.
If this is ``None``, ``ctx.author`` will be able to interact with the menu.
.. warning::
This parameter is provisional.
If no issues arise, we plan on including it under developer guarantees
in the first release made after 2024-05-18.
ephemeral: `bool`
Send the message ephemerally. This only works
if the context is from a slash command interaction.
Expand Down

0 comments on commit b15fc0e

Please sign in to comment.