mirror
/
Rapptz.discord.py
mirror of https://github.com/Rapptz/discord.py
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Change wording of InvalidArgument removal in docs

pull/7545/head
chromacoat dreamkey 3 years ago
committed by GitHub
parent
124a3ee42a
commit
095aaa9ad1
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 84 additions and 84 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 12
      discord/abc.py
  2. 16
      discord/asset.py
  3. 24
      discord/channel.py
  4. 8
      discord/client.py
  5. 36
      discord/guild.py
  6. 4
      discord/integrations.py
  7. 20
      discord/message.py
  8. 4
      discord/reaction.py
  9. 4
      discord/role.py
  10. 4
      discord/shard.py
  11. 4
      discord/template.py
  12. 4
      discord/user.py
  13. 24
      discord/webhook/async_.py
  14. 4
      discord/webhook/sync.py

12
discord/abc.py
View File

@ -752,8 +752,8 @@ class GuildChannel:
await channel.set_permissions(member, overwrite=overwrite) await channel.set_permissions(member, overwrite=overwrite)
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
@ -935,8 +935,8 @@ class GuildChannel:
.. versionadded:: 1.7 .. versionadded:: 1.7
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1283,8 +1283,8 @@ class Messageable:
**Specifying both parameters will lead to an exception**. **Specifying both parameters will lead to an exception**.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
------------ ------------

16
discord/asset.py
View File

@ -299,8 +299,8 @@ class Asset(AssetMixin):
"""Returns a new asset with the passed components replaced. """Returns a new asset with the passed components replaced.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -354,8 +354,8 @@ class Asset(AssetMixin):
"""Returns a new asset with the specified size. """Returns a new asset with the specified size.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -382,8 +382,8 @@ class Asset(AssetMixin):
"""Returns a new asset with the specified format. """Returns a new asset with the specified format.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -420,8 +420,8 @@ class Asset(AssetMixin):
not animated. Otherwise, the asset is not changed. not animated. Otherwise, the asset is not changed.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------

24
discord/channel.py
View File

@ -301,8 +301,8 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
Edits are no longer in-place, the newly edited channel is returned instead. Edits are no longer in-place, the newly edited channel is returned instead.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
---------- ----------
@ -619,8 +619,8 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
.. versionadded:: 1.3 .. versionadded:: 1.3
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -1094,8 +1094,8 @@ class VoiceChannel(VocalGuildChannel):
The ``region`` parameter now accepts :class:`str` instead of an enum. The ``region`` parameter now accepts :class:`str` instead of an enum.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------
@ -1379,8 +1379,8 @@ class StageChannel(VocalGuildChannel):
The ``region`` parameter now accepts :class:`str` instead of an enum. The ``region`` parameter now accepts :class:`str` instead of an enum.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------
@ -1537,8 +1537,8 @@ class CategoryChannel(discord.abc.GuildChannel, Hashable):
Edits are no longer in-place, the newly edited channel is returned instead. Edits are no longer in-place, the newly edited channel is returned instead.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
---------- ----------
@ -1784,8 +1784,8 @@ class StoreChannel(discord.abc.GuildChannel, Hashable):
Edits are no longer in-place, the newly edited channel is returned instead. Edits are no longer in-place, the newly edited channel is returned instead.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
---------- ----------

8
discord/client.py
View File

@ -1125,8 +1125,8 @@ class Client:
Removed the ``afk`` keyword-only parameter. Removed the ``afk`` keyword-only parameter.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------
@ -1369,8 +1369,8 @@ class Client:
``name`` and ``icon`` parameters are now keyword-only. The `region`` parameter has been removed. ``name`` and ``icon`` parameters are now keyword-only. The `region`` parameter has been removed.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------

36
discord/guild.py
View File

@ -1207,8 +1207,8 @@ class Guild(Hashable):
will be required to update the position of the channel in the channel list. will be required to update the position of the channel in the channel list.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Examples Examples
---------- ----------
@ -1310,8 +1310,8 @@ class Guild(Hashable):
This is similar to :meth:`create_text_channel` except makes a :class:`VoiceChannel` instead. This is similar to :meth:`create_text_channel` except makes a :class:`VoiceChannel` instead.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -1400,8 +1400,8 @@ class Guild(Hashable):
.. versionadded:: 1.7 .. versionadded:: 1.7
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -1471,8 +1471,8 @@ class Guild(Hashable):
cannot have categories. cannot have categories.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Raises Raises
------ ------
@ -1581,8 +1581,8 @@ class Guild(Hashable):
The ``region`` keyword parameter has been removed. The ``region`` keyword parameter has been removed.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
The ``preferred_locale`` keyword parameter now accepts an enum instead of :class:`str`. The ``preferred_locale`` keyword parameter now accepts an enum instead of :class:`str`.
@ -2086,8 +2086,8 @@ class Guild(Hashable):
The ``roles`` keyword-only parameter was added. The ``roles`` keyword-only parameter was added.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -2191,8 +2191,8 @@ class Guild(Hashable):
The returned value can be ``None``. The returned value can be ``None``.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -2889,8 +2889,8 @@ class Guild(Hashable):
The ``display_icon`` keyword-only parameter was added. The ``display_icon`` keyword-only parameter was added.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -2973,8 +2973,8 @@ class Guild(Hashable):
.. versionadded:: 1.4 .. versionadded:: 1.4
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Example Example
---------- ----------

4
discord/integrations.py
View File

@ -232,8 +232,8 @@ class StreamIntegration(Integration):
do this. do this.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------

20
discord/message.py
View File

@ -1240,8 +1240,8 @@ class Message(Hashable):
Edits are no longer in-place, the newly edited message is returned instead. Edits are no longer in-place, the newly edited message is returned instead.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -1479,8 +1479,8 @@ class Message(Hashable):
``emoji`` parameter is now positional-only. ``emoji`` parameter is now positional-only.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1516,8 +1516,8 @@ class Message(Hashable):
the :class:`abc.Snowflake` abc. the :class:`abc.Snowflake` abc.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1557,8 +1557,8 @@ class Message(Hashable):
.. versionadded:: 1.3 .. versionadded:: 1.3
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------
@ -1666,8 +1666,8 @@ class Message(Hashable):
.. versionadded:: 1.6 .. versionadded:: 1.6
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Raises Raises
-------- --------

4
discord/reaction.py
View File

@ -149,8 +149,8 @@ class Reaction:
.. versionadded:: 1.3 .. versionadded:: 1.3
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Raises Raises
-------- --------

4
discord/role.py
View File

@ -411,8 +411,8 @@ class Role(Hashable):
The ``display_icon`` keyword-only parameter was added. The ``display_icon`` keyword-only parameter was added.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------

4
discord/shard.py
View File

@ -494,8 +494,8 @@ class AutoShardedClient(Client):
Removed the ``afk`` keyword-only parameter. Removed the ``afk`` keyword-only parameter.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` instead of
:exc:`TypeError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------

4
discord/template.py
View File

@ -178,8 +178,8 @@ class Template:
The ``region`` parameter has been removed. The ``region`` parameter has been removed.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
---------- ----------

4
discord/user.py
View File

@ -367,8 +367,8 @@ class ClientUser(BaseUser):
The edit is no longer in-place, instead the newly edited client user is returned. The edit is no longer in-place, instead the newly edited client user is returned.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
----------- -----------

24
discord/webhook/async_.py
View File

@ -670,8 +670,8 @@ class WebhookMessage(Message):
The edit is no longer in-place, instead the newly edited message is returned. The edit is no longer in-place, instead the newly edited message is returned.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1063,8 +1063,8 @@ class Webhook(BaseWebhook):
"""Creates a partial :class:`Webhook` from a webhook URL. """Creates a partial :class:`Webhook` from a webhook URL.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1220,8 +1220,8 @@ class Webhook(BaseWebhook):
Edits this Webhook. Edits this Webhook.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``~InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1367,8 +1367,8 @@ class Webhook(BaseWebhook):
``embeds`` parameter, which must be a :class:`list` of :class:`Embed` objects to send. ``embeds`` parameter, which must be a :class:`list` of :class:`Embed` objects to send.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1579,8 +1579,8 @@ class Webhook(BaseWebhook):
The edit is no longer in-place, instead the newly edited message is returned. The edit is no longer in-place, instead the newly edited message is returned.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------
@ -1677,8 +1677,8 @@ class Webhook(BaseWebhook):
``message_id`` parameter is now positional-only. ``message_id`` parameter is now positional-only.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`ValueError` instead of
:exc:`ValueError`. ``InvalidArgument``.
Parameters Parameters
------------ ------------

4
discord/webhook/sync.py
View File

@ -388,8 +388,8 @@ class SyncWebhookMessage(Message):
"""Edits the message. """Edits the message.
.. versionchanged:: 2.0 .. versionchanged:: 2.0
This function no-longer raises ``InvalidArgument`` instead raising This function will now raise :exc:`TypeError` or
:exc:`ValueError` or :exc:`TypeError` in various cases. :exc:`ValueError` instead of ``InvalidArgument``.
Parameters Parameters
------------ ------------

Write Preview
Loading…
Cancel
Save