aboutsummaryrefslogtreecommitdiff
path: root/discord/widget.py
diff options
context:
space:
mode:
authorRapptz <[email protected]>2019-12-29 04:19:08 -0500
committerRapptz <[email protected]>2019-12-29 04:19:08 -0500
commit6847f131980c921880599562a5e1ce5d5634610c (patch)
tree4d274f9108a87c9935a29d83aae7b9134b66dd5b /discord/widget.py
parentRemove unnecessary pass using regex in Message.clean_content (diff)
downloaddiscord.py-6847f131980c921880599562a5e1ce5d5634610c.tar.xz
discord.py-6847f131980c921880599562a5e1ce5d5634610c.zip
Document that widget members may be incomplete.
See https://github.com/discordapp/discord-api-docs/issues/1287
Diffstat (limited to 'discord/widget.py')
-rw-r--r--discord/widget.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/discord/widget.py b/discord/widget.py
index 988b0b0e..a1037086 100644
--- a/discord/widget.py
+++ b/discord/widget.py
@@ -178,6 +178,14 @@ class Widget:
members: Optional[List[:class:`Member`]]
The online members in the server. Offline members
do not appear in the widget.
+
+ .. note::
+
+ Due to a Discord limitation, if this data is available
+ the users will be "anonymized" with linear IDs and discriminator
+ information being incorrect. Likewise, the number of members
+ retrieved is capped.
+
"""
__slots__ = ('_state', 'channels', '_invite', 'id', 'members', 'name')