Browse Source

Small docstring fixes

pull/10109/head
dolfies 4 years ago
parent
commit
7bbc38f675
  1. 18
      discord/settings.py
  2. 3
      discord/user.py

18
discord/settings.py

@ -171,45 +171,43 @@ class UserSettings:
@property @property
def tracking(self) -> Optional[Tracking]: def tracking(self) -> Optional[Tracking]:
"""Returns your tracking settings if available.""" """Optional[:class:`Tracking`]: Returns your tracking settings if available."""
return self._state.consents return self._state.consents
@property @property
def animate_stickers(self) -> StickerAnimationOptions: def animate_stickers(self) -> StickerAnimationOptions:
"""Whether or not to animate stickers in the chat.""" """:class:`StickerAnimationOptions`: Whether or not to animate stickers in the chat."""
return try_enum(StickerAnimationOptions, self._animate_stickers) return try_enum(StickerAnimationOptions, self._animate_stickers)
@property @property
def explicit_content_filter(self) -> UserContentFilter: def explicit_content_filter(self) -> UserContentFilter:
"""The filter for explicit content in all messages.""" """:class:`UserContentFilter`: The filter for explicit content in all messages."""
return try_enum(UserContentFilter, self._explicit_content_filter) return try_enum(UserContentFilter, self._explicit_content_filter)
@property @property
def friend_source_flags(self) -> FriendFlags: def friend_source_flags(self) -> FriendFlags:
"""Who can add you as a friend.""" """:class:`FriendFlags`: Who can add you as a friend."""
return FriendFlags._from_dict(self._friend_source_flags) return FriendFlags._from_dict(self._friend_source_flags)
@property @property
def guild_folders(self) -> List[GuildFolder]: def guild_folders(self) -> List[GuildFolder]:
"""A list of guild folders.""" """List[:class:`GuildFolder`]: A list of guild folders."""
state = self._state state = self._state
return [GuildFolder(data=folder, state=state) for folder in self._guild_folders] return [GuildFolder(data=folder, state=state) for folder in self._guild_folders]
@property @property
def guild_positions(self) -> List[Guild]: def guild_positions(self) -> List[Guild]:
"""A list of guilds in order of the guild/guild icons that are on """List[:class:`Guild`]: A list of guilds in order of the guild/guild icons that are on the left hand side of the UI."""
the left hand side of the UI.
"""
return list(filter(None, map(self._get_guild, self._guild_positions))) return list(filter(None, map(self._get_guild, self._guild_positions)))
@property @property
def restricted_guilds(self) -> List[Guild]: def restricted_guilds(self) -> List[Guild]:
"""A list of guilds that you will not receive DMs from.""" """List[:class:`Guild`]: A list of guilds that you will not receive DMs from."""
return list(filter(None, map(self._get_guild, self._restricted_guilds))) return list(filter(None, map(self._get_guild, self._restricted_guilds)))
@property @property
def theme(self) -> Theme: def theme(self) -> Theme:
"""The theme of the Discord UI.""" """:class:`Theme`: The theme of the Discord UI."""
return try_enum(Theme, self._theme) return try_enum(Theme, self._theme)
def _get_guild(self, id: int) -> Optional[Guild]: def _get_guild(self, id: int) -> Optional[Guild]:

3
discord/user.py

@ -635,7 +635,6 @@ class ClientUser(BaseUser):
def _update(self, data: UserPayload) -> None: def _update(self, data: UserPayload) -> None:
super()._update(data) super()._update(data)
# There's actually an Optional[str] phone field as well but I won't use it
self.verified = data.get('verified', False) self.verified = data.get('verified', False)
self.email = data.get('email') self.email = data.get('email')
self.phone = _get_as_snowflake(data, 'phone') self.phone = _get_as_snowflake(data, 'phone')
@ -1015,7 +1014,7 @@ class User(BaseUser, discord.abc.Connectable, discord.abc.Messageable):
self._stored: bool = False self._stored: bool = False
def __repr__(self) -> str: def __repr__(self) -> str:
return f'<User id={self.id} name={self.name!r} discriminator={self.discriminator!r} bot={self.bot}>' return f'<User id={self.id} name={self.name!r} discriminator={self.discriminator!r} bot={self.bot} system={self.system}>'
def __del__(self) -> None: def __del__(self) -> None:
try: try:

Loading…
Cancel
Save