Skip to content

Commit

Permalink
docs: misc fixes/clarifications (#1137)
Browse files Browse the repository at this point in the history
  • Loading branch information
shiftinv authored Feb 2, 2024
1 parent a24abf4 commit 699ffc4
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion changelog/1045.bugfix.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
|commands| Fix incorrect typings of :meth:`~disnake.ext.commands.InvokableApplicationCommand.add_check`, :meth:`~disnake.ext.commands.InvokableApplicationCommand.remove_check`, :meth:`~disnake.ext.commands.InteractionBotBase.add_app_command_check` and :meth:`~disnake.ext.commands.InteractionBotBase.remove_app_command_check`.
|commands| Fix incorrect typings of :meth:`InvokableApplicationCommand.add_check <.ext.commands.InvokableApplicationCommand.add_check>`, :meth:`InvokableApplicationCommand.remove_check <.ext.commands.InvokableApplicationCommand.remove_check>`, :meth:`Bot.add_app_command_check <.ext.commands.Bot.add_app_command_check>` and :meth:`Bot.remove_app_command_check <.ext.commands.Bot.remove_app_command_check>`.
2 changes: 1 addition & 1 deletion changelog/1111.bugfix.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Allow ``cls`` argument in select menu decorators (e.g. :func`ui.string_select`) to be specified by keyword instead of being positional-only.
Allow ``cls`` argument in select menu decorators (e.g. :func:`ui.string_select`) to be specified by keyword instead of being positional-only.
6 changes: 0 additions & 6 deletions disnake/abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -1297,12 +1297,6 @@ async def create_invite(
max_age: :class:`int`
How long the invite should last in seconds. If set to ``0``, then the invite
doesn't expire. Defaults to ``0``.
.. warning::
If the guild is not a Community guild (has ``COMMUNITY`` in :attr:`.Guild.features`),
this must be set to a number between ``1`` and ``2592000`` seconds.
max_uses: :class:`int`
How many uses the invite could be used for. If it's 0 then there
are unlimited uses. Defaults to ``0``.
Expand Down
8 changes: 8 additions & 0 deletions disnake/ext/commands/common_bot_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ def add_cog(self, cog: Cog, *, override: bool = False) -> None:
A cog is a class that has its own event listeners and commands.
This automatically re-syncs application commands, provided that
:attr:`command_sync_flags.sync_on_cog_actions <.CommandSyncFlags.sync_on_cog_actions>`
isn't disabled.
.. versionchanged:: 2.0
:exc:`.ClientException` is raised when a cog with the same name
Expand Down Expand Up @@ -228,6 +232,10 @@ def remove_cog(self, name: str) -> Optional[Cog]:
If no cog is found then this method has no effect.
This automatically re-syncs application commands, provided that
:attr:`command_sync_flags.sync_on_cog_actions <.CommandSyncFlags.sync_on_cog_actions>`
isn't disabled.
Parameters
----------
name: :class:`str`
Expand Down
2 changes: 1 addition & 1 deletion disnake/threads.py
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,7 @@ async def remove_user(self, user: Snowflake) -> None:
Parameters
----------
user: :class:`abc.Snowflake`
The user to add to the thread.
The user to remove from the thread.
Raises
------
Expand Down
2 changes: 1 addition & 1 deletion disnake/ui/select/role.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@


class RoleSelect(BaseSelect[RoleSelectMenu, "Role", V_co]):
"""Represents a UI user select menu.
"""Represents a UI role select menu.
This is usually represented as a drop down menu.
Expand Down

0 comments on commit 699ffc4

Please sign in to comment.