aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2019-06-09 00:39:38 -0400
committerRapptz <[email protected]>2019-06-09 00:39:38 -0400
commita8f0a0324761c0bae9a14ac81b3eba2de8b248ae (patch)
tree7336e79ba515bf276758f07363cfebf2009addc7 /docs
parentFix reference typo in SystemChannelFlags (diff)
downloaddiscord.py-a8f0a0324761c0bae9a14ac81b3eba2de8b248ae.tar.xz
discord.py-a8f0a0324761c0bae9a14ac81b3eba2de8b248ae.zip
Version bump to 1.2.0v1.2.0
Diffstat (limited to 'docs')
-rw-r--r--docs/ext/commands/index.rst2
-rw-r--r--docs/ext/tasks/index.rst2
-rw-r--r--docs/whats_new.rst56
3 files changed, 60 insertions, 0 deletions
diff --git a/docs/ext/commands/index.rst b/docs/ext/commands/index.rst
index df7f0781..fba57359 100644
--- a/docs/ext/commands/index.rst
+++ b/docs/ext/commands/index.rst
@@ -1,3 +1,5 @@
+.. _discord_ext_commands:
+
``discord.ext.commands`` -- Bot commands framework
====================================================
diff --git a/docs/ext/tasks/index.rst b/docs/ext/tasks/index.rst
index 27f080c9..206a7beb 100644
--- a/docs/ext/tasks/index.rst
+++ b/docs/ext/tasks/index.rst
@@ -1,3 +1,5 @@
+.. _discord_ext_tasks:
+
``discord.ext.tasks`` -- asyncio.Task helpers
====================================================
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
index 7569e384..7e9d7720 100644
--- a/docs/whats_new.rst
+++ b/docs/whats_new.rst
@@ -1,5 +1,8 @@
.. currentmodule:: discord
+.. |commands| replace:: [:ref:`ext.commands <discord_ext_commands>`]
+.. |tasks| replace:: [:ref:`ext.tasks <discord_ext_tasks>`]
+
.. _whats_new:
Changelog
@@ -8,6 +11,59 @@ Changelog
This page keeps a detailed human friendly rendering of what's new and changed
in specific versions.
+.. _vp1p2p0:
+
+v1.2.0
+--------
+
+This update mainly brings performance improvements and various nitro boosting attributes (referred to in the API as "premium guilds").
+
+New Features
+~~~~~~~~~~~~~~
+
+- Add :attr:`Guild.premium_tier` to query the guild's current nitro boost level.
+- Add :attr:`Guild.emoji_limit`, :attr:`Guild.bitrate_limit`, :attr:`Guild.filesize_limit` to query the new limits of a guild when taking into consideration boosting.
+- Add :attr:`Guild.premium_subscription_count` to query how many members are boosting a guild.
+- Add :attr:`Member.premium_since` to query since when a member has boosted a guild.
+- Add :attr:`Guild.premium_subscribers` to query all the members currently boosting the guild.
+- Add :attr:`Guild.system_channel_flags` to query the settings for a guild's :attr:`Guild.system_channel`.
+ - This includes a new type named :class:`SystemChannelFlags`
+- Add :attr:`Emoji.available` to query if an emoji can be used (within the guild or otherwise).
+- Add support for animated icons in :meth:`Guild.icon_url_as` and :attr:`Guild.icon_url`.
+- Add :meth:`Guild.is_icon_animated`.
+- Add support for the various new :class:`MessageType` involving nitro boosting.
+- Add :attr:`VoiceRegion.india`. (:issue:`2145`)
+- Add :meth:`Embed.insert_field_at`. (:issue:`2178`)
+- Add a ``type`` attribute for all channels to their appropriate :class:`ChannelType`. (:issue:`2185`)
+- |tasks| Add :meth:`Loop.stop <.ext.tasks.Loop.stop>` to gracefully stop a task rather than cancelling.
+- |tasks| Add :meth:`Loop.failed <.ext.tasks.Loop.failed>` to query if a task had failed somehow.
+- |tasks| Add :meth:`Loop.change_interval <.ext.tasks.Loop.change_interval>` to change the sleep interval at runtime (:issue:`2158`, :issue:`2162`)
+
+Bug Fixes
+~~~~~~~~~~~
+
+- Fix internal error when using :meth:`Guild.prune_members`.
+- |commands| Fix :attr:`~ext.commands.Group.invoked_subcommand` being invalid in many cases.
+- |tasks| Reset iteration count when the loop terminates and is restarted.
+- |tasks| The decorator interface now works as expected when stacking (:issue:`2154`)
+
+Miscellaneous
+~~~~~~~~~~~~~~~
+
+- Improve performance of all Enum related code significantly.
+ - This was done by replacing the ``enum.Enum`` code with an API compatible one.
+ - This should not be a breaking change for most users due to duck-typing.
+- Improve performance of message creation by about 1.5x.
+- Improve performance of message editing by about 1.5-4x depending on payload size.
+- Improve performance of attribute access on :class:`Member` about by 2x.
+- Improve performance of :func:`utils.get` by around 4-6x depending on usage.
+- Improve performance of event parsing lookup by around 2.5x.
+- Keyword arguments in :meth:`Client.start` and :meth:`Client.run` are now validated (:issue:`953`, :issue:`2170`)
+- The Discord error code is now shown in the exception message for :exc:`HTTPException`.
+- Internal tasks launched by the library will now have their own custom ``__repr__``.
+- All public facing types should now have a proper and more detailed ``__repr__``.
+- |tasks| Errors are now logged via the standard :mod:`py:logging` module.
+
.. _vp1p1p1:
v1.1.1