diff options
| author | Rapptz <[email protected]> | 2016-01-30 06:07:06 -0500 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2016-01-30 06:07:06 -0500 |
| commit | 94d31834fc52ba2887b2f00b2756790c96cf22b9 (patch) | |
| tree | 63d6167ca4f0095b599a258aad22d760f2f54da4 /docs | |
| parent | Update member references when status changes. (diff) | |
| download | discord.py-94d31834fc52ba2887b2f00b2756790c96cf22b9.tar.xz discord.py-94d31834fc52ba2887b2f00b2756790c96cf22b9.zip | |
Change enumerators into enumerations to please Voltana.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 8 | ||||
| -rw-r--r-- | docs/migrating.rst | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/api.rst b/docs/api.rst index d541ba81..a7140895 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -331,13 +331,13 @@ Utility Functions .. _discord-api-enums: -Enumerators ------------- +Enumerations +------------- -The API provides some enumerators for certain types of strings to avoid the API +The API provides some enumerations for certain types of strings to avoid the API from being stringly typed in case the strings change in the future. -All enumerators are subclasses of `enum`_. +All enumerations are subclasses of `enum`_. .. _enum: https://docs.python.org/3/library/enum.html diff --git a/docs/migrating.rst b/docs/migrating.rst index 5e909e0f..df0526c2 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -163,11 +163,11 @@ In order to get the old behaviour you should explicitly cast it to a list. .. _migrating-enums: -Enumerators +Enumerations ------------ Due to dropping support for versions lower than Python 3.4.2, the library can now use -`enumerators <https://docs.python.org/3/library/enum.html>`_ in places where it makes sense. +`enumerations <https://docs.python.org/3/library/enum.html>`_ in places where it makes sense. The common places where this was changed was in the server region, member status, and channel type. @@ -187,7 +187,7 @@ After: member.status = discord.Status.online channel.type == discord.ChannelType.text -The main reason for this change was to reduce the use of finnicky strings in the API as this +The main reason for this change was to reduce the use of finicky strings in the API as this could give users a false sense of power. More information can be found in the :ref:`discord-api-enums` page. .. _migrating-properties: |