Skip to content

Commit 27a15ee

Browse files
committed
📝 Better docs
1 parent 6a91875 commit 27a15ee

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

discord/role.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,19 +122,19 @@ class RoleType(IntEnum):
122122
Attributes
123123
----------
124124
APPLICATION: :class:`int`
125-
The role is an application role.
125+
The role is an application (bot) role.
126126
BOOSTER: :class:`int`
127127
The role is a guild's booster role.
128128
GUILD_PRODUCT: :class:`int`
129129
The role is a guild product role.
130130
PREMIUM_SUBSCRIPTION_BASE: :class:`int`
131-
The role is a base subscription role.
131+
The role is a base subscription role. This is not possible to determine currently, will be INTEGRATION if it's a base subscription.
132132
PREMIUM_SUBSCRIPTION_TIER: :class:`int`
133133
The role is a subscription role.
134134
DRAFT_PREMIUM_SUBSCRIPTION_TIER: :class:`int`
135135
The role is a draft subscription role.
136136
INTEGRATION: :class:`int`
137-
The role is an integration role.
137+
The role is an integration role, such as Twitch or YouTube, or a base subscription role.
138138
CONNECTION: :class:`int`
139139
The role is a guild connections role.
140140
"""
@@ -157,11 +157,13 @@ class RoleTags:
157157
that gives it context for the reason the role is managed.
158158
159159
Role tags are a fairly complex topic, since it's usually hard to determine which role tag combination represents which role type.
160-
We aim to improve the documentation / introduce new attributes in future.
161-
For the meantime read `this <https://lulalaby.notion.site/Special-Roles-Documentation-17411d3839e680abbb1eff63c51bd7a7?pvs=4>`_ if you need detailed information about how role tags work.
160+
In order to make your life easier, pycord provides a :attr:`RoleTags.type` attribute that attempts to determine the role type based on the role tags. It's value is not provided by discord but is rather computed by pycord based on the role tags.
161+
If you find an issue, please open an issue on `GitHub <https://github.com/Pycord-Development/pycord/issues/new?template=bug_report.yml>`_.
162+
Read `this <https://lulalaby.notion.site/Special-Roles-Documentation-17411d3839e680abbb1eff63c51bd7a7?pvs=4>`_ if you need detailed information about how role tags work.
162163
163164
.. versionadded:: 1.6
164165
.. versionchanged:: 2.7
166+
The type of the role is now determined by the :attr:`RoleTags.type` attribute.
165167
166168
Attributes
167169
----------

0 commit comments

Comments
 (0)