Skip to content

Commit bb0fcf5

Browse files
authored
docs: update required permissions for Guild.invites (#1348)
1 parent 2e549f0 commit bb0fcf5

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

changelog/1348.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update required permissions for :meth:`Guild.invites` and in the invite attribute :ref:`table <invite_attr_table>`.

disnake/guild.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3184,8 +3184,10 @@ async def invites(self) -> List[Invite]:
31843184
31853185
Returns a list of all active instant invites from the guild.
31863186
3187-
You must have :attr:`~Permissions.manage_guild` permission to
3188-
use this.
3187+
You must have :attr:`~Permissions.manage_guild` or :attr:`~Permissions.view_audit_log`
3188+
permission to use this.
3189+
Some attributes (see :ref:`table <invite_attr_table>`) are only available with
3190+
:attr:`~Permissions.manage_guild` permissions.
31893191
31903192
.. note::
31913193

disnake/invite.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -281,15 +281,20 @@ class Invite(Hashable):
281281
+------------------------------------+---------------------------------------------------------------------+
282282
| Attribute | Method |
283283
+====================================+=====================================================================+
284-
| :attr:`max_age` | :meth:`abc.GuildChannel.invites`\\, :meth:`Guild.invites` |
284+
| :attr:`max_age` | :meth:`Guild.invites` with :attr:`~Permissions.manage_guild` |
285+
| | permissions, :meth:`abc.GuildChannel.invites` |
285286
+------------------------------------+---------------------------------------------------------------------+
286-
| :attr:`max_uses` | :meth:`abc.GuildChannel.invites`\\, :meth:`Guild.invites` |
287+
| :attr:`max_uses` | :meth:`Guild.invites` with :attr:`~Permissions.manage_guild` |
288+
| | permissions, :meth:`abc.GuildChannel.invites` |
287289
+------------------------------------+---------------------------------------------------------------------+
288-
| :attr:`created_at` | :meth:`abc.GuildChannel.invites`\\, :meth:`Guild.invites` |
290+
| :attr:`created_at` | :meth:`Guild.invites` with :attr:`~Permissions.manage_guild` |
291+
| | permissions, :meth:`abc.GuildChannel.invites` |
289292
+------------------------------------+---------------------------------------------------------------------+
290-
| :attr:`temporary` | :meth:`abc.GuildChannel.invites`\\, :meth:`Guild.invites` |
293+
| :attr:`temporary` | :meth:`Guild.invites` with :attr:`~Permissions.manage_guild` |
294+
| | permissions, :meth:`abc.GuildChannel.invites` |
291295
+------------------------------------+---------------------------------------------------------------------+
292-
| :attr:`uses` | :meth:`abc.GuildChannel.invites`\\, :meth:`Guild.invites` |
296+
| :attr:`uses` | :meth:`Guild.invites` with :attr:`~Permissions.manage_guild` |
297+
| | permissions, :meth:`abc.GuildChannel.invites` |
293298
+------------------------------------+---------------------------------------------------------------------+
294299
| :attr:`approximate_member_count` | :meth:`Client.fetch_invite` with ``with_counts`` enabled |
295300
+------------------------------------+---------------------------------------------------------------------+

0 commit comments

Comments
 (0)