diff options
| author | Harmon <[email protected]> | 2020-01-22 22:55:05 -0600 |
|---|---|---|
| committer | Danny <[email protected]> | 2020-01-22 23:55:05 -0500 |
| commit | 6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f (patch) | |
| tree | 8df53b1ae373eb4dc0e05c3df4f2c388497e5499 /docs | |
| parent | 1.3.0 changelog: fetch_roles fetches roles, not members (diff) | |
| download | discord.py-6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f.tar.xz discord.py-6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f.zip | |
Fixes and improvements for v1.3 documentation
* Add missing versionadded strings for v1.3
* Add missing versionchanged string for Message.edit
* Consistently use versionadded for attributes
* Consistently use versionchanged for parameters
* Use versionchanged for Bot.is_owner
* Fix references in v1.3 changelog
* Improve grammar in v1.3 changelog
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 43 | ||||
| -rw-r--r-- | docs/whats_new.rst | 8 |
2 files changed, 41 insertions, 10 deletions
diff --git a/docs/api.rst b/docs/api.rst index 02ba215e..54ba123a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -768,9 +768,15 @@ Profile .. attribute:: team_user A boolean indicating if the user is in part of a team. + + .. versionadded:: 1.3 + .. attribute:: system A boolean indicating if the user is officially part of the Discord urgent message system. + + .. versionadded:: 1.3 + .. attribute:: mutual_guilds A list of :class:`Guild` that the :class:`ClientUser` shares with this @@ -914,12 +920,6 @@ of :class:`enum.Enum`. Specifies the region a voice server belongs to. - .. versionchanged:: 1.2 - The ``india`` region was added. - - .. versionchanged:: 1.3 - The ``europe`` and ``dubai`` regions were added. - .. attribute:: amsterdam The Amsterdam region. @@ -929,6 +929,9 @@ of :class:`enum.Enum`. .. attribute:: dubai The Dubai region. + + .. versionadded:: 1.3 + .. attribute:: eu_central The EU Central region. @@ -938,6 +941,9 @@ of :class:`enum.Enum`. .. attribute:: europe The Europe region. + + .. versionadded:: 1.3 + .. attribute:: frankfurt The Frankfurt region. @@ -947,6 +953,9 @@ of :class:`enum.Enum`. .. attribute:: india The India region. + + .. versionadded:: 1.2 + .. attribute:: japan The Japan region. @@ -1332,6 +1341,8 @@ of :class:`enum.Enum`. - ``channel``: A :class:`TextChannel` or :class:`Object` with the channel ID where the members were moved. - ``count``: An integer specifying how many members were moved. + .. versionadded:: 1.3 + .. attribute:: member_disconnect A member's voice state has changed. This triggers when a @@ -1342,6 +1353,8 @@ of :class:`enum.Enum`. - ``count``: An integer specifying how many members were disconnected. + .. versionadded:: 1.3 + .. attribute:: bot_add A bot was added to the guild. @@ -1349,6 +1362,8 @@ of :class:`enum.Enum`. When this is the action, the type of :attr:`~AuditLogEntry.target` is the :class:`Member` or :class:`User` which was added to the guild. + .. versionadded:: 1.3 + .. attribute:: role_create A new role was created. @@ -1540,6 +1555,8 @@ of :class:`enum.Enum`. - ``count``: An integer specifying how many messages were deleted. + .. versionadded:: 1.3 + .. attribute:: message_pin A message was pinned in a channel. @@ -1553,6 +1570,8 @@ of :class:`enum.Enum`. - ``channel``: A :class:`TextChannel` or :class:`Object` with the channel ID where the message was pinned. - ``message_id``: the ID of the message which was pinned. + .. versionadded:: 1.3 + .. attribute:: message_unpin A message was unpinned in a channel. @@ -1566,6 +1585,8 @@ of :class:`enum.Enum`. - ``channel``: A :class:`TextChannel` or :class:`Object` with the channel ID where the message was unpinned. - ``message_id``: the ID of the message which was unpinned. + .. versionadded:: 1.3 + .. attribute:: integration_create A guild integration was created. @@ -1573,6 +1594,8 @@ of :class:`enum.Enum`. When this is the action, the type of :attr:`~AuditLogEntry.target` is the :class:`Object` with the integration ID of the integration which was created. + .. versionadded:: 1.3 + .. attribute:: integration_update A guild integration was updated. @@ -1580,6 +1603,8 @@ of :class:`enum.Enum`. When this is the action, the type of :attr:`~AuditLogEntry.target` is the :class:`Object` with the integration ID of the integration which was updated. + .. versionadded:: 1.3 + .. attribute:: integration_delete A guild integration was deleted. @@ -1587,6 +1612,8 @@ of :class:`enum.Enum`. When this is the action, the type of :attr:`~AuditLogEntry.target` is the :class:`Object` with the integration ID of the integration which was deleted. + .. versionadded:: 1.3 + .. class:: AuditLogActionCategory Represents the category that the :class:`AuditLogAction` belongs to. @@ -1721,6 +1748,8 @@ of :class:`enum.Enum`. Represents the membership state of a team member retrieved through :func:`Bot.application_info`. + .. versionadded:: 1.3 + .. attribute:: invited Represents an invited member. @@ -1733,6 +1762,8 @@ of :class:`enum.Enum`. Represents the type of webhook that can be received. + .. versionadded:: 1.3 + .. attribute:: incoming Represents a webhook that can post messages to channels with a token. diff --git a/docs/whats_new.rst b/docs/whats_new.rst index 8ae0cfed..86d9d06b 100644 --- a/docs/whats_new.rst +++ b/docs/whats_new.rst @@ -25,7 +25,7 @@ New Features - Add :meth:`Guild.fetch_roles` to fetch roles from the HTTP API. (:issue:`2208`) - Add support for teams via :class:`Team` when fetching with :meth:`Client.application_info`. (:issue:`2239`) - Add support for suppressing embeds via :meth:`Message.edit` -- Add support for guild subscriptions, see the :class:`Client` documentation for more details. +- Add support for guild subscriptions. See the :class:`Client` documentation for more details. - Add :attr:`VoiceChannel.voice_states` to get voice states without relying on member cache. - Add :meth:`Guild.query_members` to request members from the gateway. - Add :class:`FFmpegOpusAudio` and other voice improvements. (:issue:`2258`) @@ -56,7 +56,7 @@ New Features - Add :attr:`User.system` and :attr:`Profile.system` to know whether a user is an official Discord Trust and Safety account. - Add :attr:`Profile.team_user` to check whether a user is a member of a team. - Add :meth:`Attachment.to_file` to easily convert attachments to :class:`File` for sending. -- Add certain aliases to :class:`Permission` to match the UI better. (:issue:`2496`) +- Add certain aliases to :class:`Permissions` to match the UI better. (:issue:`2496`) - :attr:`Permissions.manage_permissions` - :attr:`Permissions.view_channel` - :attr:`Permissions.use_external_emojis` @@ -66,11 +66,11 @@ New Features - Add support for :func:`on_invite_create` and :func:`on_invite_delete` events. - Add support for clearing a specific reaction emoji from a message. - - :meth:`Message.clear_reaction` and :class:`Reaction.clear` methods. + - :meth:`Message.clear_reaction` and :meth:`Reaction.clear` methods. - :func:`on_raw_reaction_clear_emoji` and :func:`on_reaction_clear_emoji` events. - Add :func:`utils.sleep_until` helper to sleep until a specific datetime. (:issue:`2517`, :issue:`2519`) -- |commands| Add support for teams and :attr:`Bot.owner_ids` to have multiple bot owners. (:issue:`2239`) +- |commands| Add support for teams and :attr:`Bot.owner_ids <.ext.commands.Bot.owner_ids>` to have multiple bot owners. (:issue:`2239`) - |commands| Add new :attr:`BucketType.role <.ext.commands.BucketType.role>` bucket type. (:issue:`2201`) - |commands| Expose :attr:`Command.cog <.ext.commands.Command.cog>` property publicly. (:issue:`2360`) - |commands| Add non-decorator interface for adding checks to commands via :meth:`Command.add_check <.ext.commands.Command.add_check>` and :meth:`Command.remove_check <.ext.commands.Command.remove_check>`. (:issue:`2411`) |