diff --git a/docs/api.rst b/docs/api.rst index d541ba811..a71408959 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 5e909e0fd..df0526c2c 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 `_ in places where it makes sense. +`enumerations `_ 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: