diff --git a/discord/flags.py b/discord/flags.py index 08e99faa6..99d2ef2f2 100644 --- a/discord/flags.py +++ b/discord/flags.py @@ -577,7 +577,7 @@ class ApplicationFlags(BaseFlags): class GuildSubscriptionOptions: - """Controls the library's auto-subscribing feature. + r"""Controls the library's auto-subscribing feature. Subscribing refers to abusing the member sidebar to scrape all* guild members. However, you can only request 200 members per OPCode 14. @@ -586,8 +586,8 @@ class GuildSubscriptionOptions: GUILD_MEMBER_LIST_UPDATE. You then also get subsequent GUILD_MEMBER_LIST_UPDATEs that act (kind of) like GUILD_MEMBER_UPDATE/ADD/REMOVEs. - *Discord doesn't provide offline members for "large" guilds. - *As this is dependent on the member sidebar, guilds that don't have + \*Discord doesn't provide offline members for "large" guilds. + \*As this is dependent on the member sidebar, guilds that don't have a channel (of any type, surprisingly) that @everyone or some other role everyone has can't access don't get the full online member list. @@ -608,7 +608,7 @@ class GuildSubscriptionOptions: self.max_online = max_online def __repr__(self) -> str: - return ' GuildSubscriptionOptions: @@ -622,7 +622,16 @@ class GuildSubscriptionOptions: @classmethod def disabled(cls) -> GuildSubscriptionOptions: - """A factory method that creates a :class:`GuildSubscriptionOptions` with subscribing disabled.""" + """A factory method that creates a :class:`GuildSubscriptionOptions` with subscribing disabled. + + There is an alias for this called :meth`none`. + """ return cls(auto_subscribe=False) - off = disabled + @classmethod + def off(cls) -> GuildSubscriptionOptions: + """A factory method that creates a :class:`GuildSubscriptionOptions` with subscribing disabled. + + This is an alias of :meth:`disabled`. + """ + return cls(auto_subscribe=False) diff --git a/discord/settings.py b/discord/settings.py index 26f53769d..6cdcdbe91 100644 --- a/discord/settings.py +++ b/discord/settings.py @@ -266,7 +266,7 @@ class ChannelSettings: @property def channel(self) -> Optional[GuildChannel]: - """Optional[:class:`GuildChannel]: Returns the channel these settings are for.""" + """Optional[:class:`GuildChannel`]: Returns the channel these settings are for.""" guild = self._state._get_guild(self._guild_id) return guild and guild.get_channel(self._channel_id) diff --git a/discord/user.py b/discord/user.py index 71100ac1f..a98f5bc3f 100644 --- a/discord/user.py +++ b/discord/user.py @@ -56,6 +56,7 @@ __all__ = ( 'User', 'ClientUser', 'Profile', + 'Note', ) BU = TypeVar('BU', bound='BaseUser') diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index d9fe22315..e7775ebd6 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -58,9 +58,8 @@ {#- The main navigation header #}