diff --git a/docs/installing.rst b/docs/installing.rst index 75a88e1046..9a05f202cc 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -22,15 +22,15 @@ is not provided. Python 2.7 or lower is not supported. Python 3.7 or lower is no Installing ----------- -**!!! IMPORTANT !!!** +.. note:: -For new features like options, buttons, and threads, you need to install from git until our v2.0 release on Jan 28th, 2022. :: + For new features like options, buttons, and threads, you need to install the pre-release until our v2.0 release. :: - python3 -m pip install -U git+https://github.com/Pycord-Development/pycord + python3 -m pip install -U py-cord --pre -For Windows users, this command should be used to install from git: :: + For Windows users, this command should be used to install the pre-release: :: - py -3 -m pip install -U git+https://github.com/Pycord-Development/pycord + py -3 -m pip install -U py-cord --pre You can get the library directly from PyPI: :: @@ -41,7 +41,7 @@ If you are using Windows, then the following should be used instead: :: py -3 -m pip install -U py-cord -To install additional packages for speedup, you should use ``py-cord[speed]`` instead of ``py-cord``, e.g. :: +To install additional packages for speedup, you should use ``py-cord[speed]`` instead of ``py-cord``, e.g. .. code:: sh diff --git a/docs/intents.rst b/docs/intents.rst index f0e8ab79b4..9472db3823 100644 --- a/docs/intents.rst +++ b/docs/intents.rst @@ -11,7 +11,7 @@ In version 1.5 comes the introduction of :class:`Intents`. This is a radical cha These intents are passed to the constructor of :class:`Client` or its subclasses (:class:`AutoShardedClient`, :class:`~.AutoShardedBot`, :class:`~.Bot`) with the ``intents`` argument. -If intents are not passed, then the library defaults to every intent being enabled except the privileged intents, currently :attr:`Intents.members`, :attr:`Intents.presences`, and :attr:`Intents.guild_messages`. +If intents are not passed, then the library defaults to every intent being enabled except the privileged intents, currently :attr:`Intents.members`, :attr:`Intents.presences`, and :attr:`Intents.message_content`. What intents are needed? -------------------------- @@ -34,7 +34,7 @@ For example, if you want a bot that functions without spammy events like presenc # from discord.ext import commands # bot = commands.Bot(command_prefix='!', intents=intents) -Note that this doesn't enable :attr:`Intents.members` or :attr:`Intents.guild_messages` since they are privileged intents. +Note that this doesn't enable :attr:`Intents.members` or :attr:`Intents.message_content` since they are privileged intents. Another example showing a bot that only deals with messages and guild information: @@ -113,12 +113,11 @@ Message Content Intent ++++++++++++++++++++++ - Whether you have a message based command system using ext.commands -- Whether you use the :func:`on_message` event for anything, such as auto-moderation. -- Whether you track message edits or deletions using :func:`on_message_edit`, :func:`on_message_delete`, :func:`on_raw_message_edit`, :func:`on_raw_message_delete`. -- Whether you use any reaction related events, such as :func:`on_reaction_add`, :func:`on_reaction_remove`, and :func:`on_reaction_clear` +- Whether you use the :func:`on_message` event for anything using message content, such as auto-moderation. +- Whether you use message content in :func:`on_message_edit`, :func:`on_message_delete`, :func:`on_raw_message_edit`, :func:`on_raw_message_delete`. .. note:: - This only applies to :attr:`Intents.guild_messages`, not :attr:`Intents.dm_messages`. The bot can still receive message contents in DMs, when mentioned in guild messages, and for its own guild messages. + The bot can still receive message contents in DMs, when mentioned in guild messages, and for its own guild messages. .. _intents_member_cache: diff --git a/docs/quickstart.rst b/docs/quickstart.rst index bcd72c9485..702ee5f2b6 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -7,8 +7,8 @@ Quickstart ========== -This page gives a brief introduction to the library. It assumes you have the library installed, -if you don't check the :ref:`installing` portion. +This page gives a brief introduction to the library. It assumes you have the library installed. +If you don't, check the :ref:`installing` portion. A Minimal Bot -------------