matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Consistent usage of RST inline code within Guild.features references

Browse Source
This commit is contained in:
Rapptz 2020-05-23 22:05:59 -04:00
parent ed80ba6a5e
commit 1ee1b7feea
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
discord/guild.py
View File

@ -469,7 +469,7 @@ class Guild(Hashable):
def public_updates_channel(self): def public_updates_channel(self):
"""Optional[:class:`TextChannel`]: Return's the guild's channel where admins and """Optional[:class:`TextChannel`]: Return's the guild's channel where admins and
moderators of the guilds receive notices from Discord. This is only available to moderators of the guilds receive notices from Discord. This is only available to
guilds that contain `PUBLIC` in :attr:`Guild.features`. guilds that contain ``PUBLIC`` in :attr:`Guild.features`.
If no channel is set, then this returns ``None``. If no channel is set, then this returns ``None``.
@ -976,10 +976,10 @@ class Guild(Hashable):
The new name of the guild. The new name of the guild.
description: :class:`str` description: :class:`str`
The new description of the guild. This is only available to guilds that The new description of the guild. This is only available to guilds that
contain `PUBLIC` in :attr:`Guild.features`. contain ``PUBLIC`` in :attr:`Guild.features`.
icon: :class:`bytes` icon: :class:`bytes`
A :term:`py:bytes-like object` representing the icon. Only PNG/JPEG supported A :term:`py:bytes-like object` representing the icon. Only PNG/JPEG supported
and GIF This is only available to guilds that contain `ANIMATED_ICON` in :attr:`Guild.features`. and GIF This is only available to guilds that contain ``ANIMATED_ICON`` in :attr:`Guild.features`.
Could be ``None`` to denote removal of the icon. Could be ``None`` to denote removal of the icon.
banner: :class:`bytes` banner: :class:`bytes`
A :term:`py:bytes-like object` representing the banner. A :term:`py:bytes-like object` representing the banner.
@ -987,7 +987,7 @@ class Guild(Hashable):
splash: :class:`bytes` splash: :class:`bytes`
A :term:`py:bytes-like object` representing the invite splash. A :term:`py:bytes-like object` representing the invite splash.
Only PNG/JPEG supported. Could be ``None`` to denote removing the Only PNG/JPEG supported. Could be ``None`` to denote removing the
splash. This is only available to guilds that contain `INVITE_SPLASH` splash. This is only available to guilds that contain ``INVITE_SPLASH``
in :attr:`Guild.features`. in :attr:`Guild.features`.
region: :class:`VoiceRegion` region: :class:`VoiceRegion`
The new region for the guild's voice communication. The new region for the guild's voice communication.
@ -1012,11 +1012,11 @@ class Guild(Hashable):
The new system channel settings to use with the new system channel. The new system channel settings to use with the new system channel.
rules_channel: Optional[:class:`TextChannel`] rules_channel: Optional[:class:`TextChannel`]
The new channel that is used for rules. This is only available to The new channel that is used for rules. This is only available to
guilds that contain `PUBLIC` in :attr:`Guild.features`. Could be ``None`` for no rules guilds that contain ``PUBLIC`` in :attr:`Guild.features`. Could be ``None`` for no rules
channel. channel.
public_updates_channel: Optional[:class:`TextChannel`] public_updates_channel: Optional[:class:`TextChannel`]
The new channel that is used for public updates from Discord. This is only available to The new channel that is used for public updates from Discord. This is only available to
guilds that contain `PUBLIC` in :attr:`Guild.features`. Could be ``None`` for no guilds that contain ``PUBLIC`` in :attr:`Guild.features`. Could be ``None`` for no
public updates channel. public updates channel.
reason: Optional[:class:`str`] reason: Optional[:class:`str`]
The reason for editing this guild. Shows up on the audit log. The reason for editing this guild. Shows up on the audit log.
@ -1136,7 +1136,7 @@ class Guild(Hashable):
fields['rules_channel_id'] = rules_channel fields['rules_channel_id'] = rules_channel
else: else:
fields['rules_channel_id'] = rules_channel.id fields['rules_channel_id'] = rules_channel.id
try: try:
public_updates_channel = fields.pop('public_updates_channel') public_updates_channel = fields.pop('public_updates_channel')
except KeyError: except KeyError:
@ -1356,7 +1356,7 @@ class Guild(Hashable):
to prevent timeouts, you must set this to ``False``. If this is to prevent timeouts, you must set this to ``False``. If this is
set to ``False``\, then this function will always return ``None``. set to ``False``\, then this function will always return ``None``.
roles: Optional[List[:class:`abc.Snowflake`]] roles: Optional[List[:class:`abc.Snowflake`]]
A list of :class:`abc.Snowflake` that represent roles to include in the pruning process. If a member A list of :class:`abc.Snowflake` that represent roles to include in the pruning process. If a member
has a role that is not specified, they'll be excluded. has a role that is not specified, they'll be excluded.
Raises Raises
@ -1741,7 +1741,7 @@ class Guild(Hashable):
Returns the guild's special vanity invite. Returns the guild's special vanity invite.
The guild must have 'VANITY_URL' in :attr:`~Guild.features`. The guild must have ``VANITY_URL`` in :attr:`~Guild.features`.
You must have the :attr:`~Permissions.manage_guild` permission to use You must have the :attr:`~Permissions.manage_guild` permission to use
this as well. this as well.