Browse Source

Finalize documentation

pull/10109/head
dolfies 3 years ago
parent
commit
552864b290
  1. 2
      discord/appinfo.py
  2. 10
      discord/client.py
  3. 3
      discord/user.py

2
discord/appinfo.py

@ -560,7 +560,7 @@ class InteractionApplication(Hashable):
Only available from :attr:`~Modal.application`.
command_count: Optional[:class:`int`]
The number of commands the application has.
Only available from :attr:`~abc.BaseCommand.application`.
Only available from :attr:`~BaseCommand.application`.
"""
__slots__ = (

10
discord/client.py

@ -724,7 +724,7 @@ class Client:
@property
def voice_client(self) -> Optional[VoiceProtocol]:
"""Optional[:class:`.VoiceProtocol`]: Returns the :class:`VoiceProtocol` associated with private calls, if any."""
"""Optional[:class:`.VoiceProtocol`]: Returns the :class:`.VoiceProtocol` associated with private calls, if any."""
return self._connection._get_voice_client(self._connection.self_id)
@property
@ -869,7 +869,7 @@ class Client:
@property
def activity(self) -> Optional[ActivityTypes]:
"""Optional[Union[:class:`BaseActivity`, :class:`Spotify`]]: Returns the primary
"""Optional[Union[:class:`.BaseActivity`, :class:`.Spotify`]]: Returns the primary
activity the client is currently doing. Could be ``None`` if no activity is being done.
.. versionadded:: 2.0
@ -1324,7 +1324,7 @@ class Client:
----------
activity: Optional[:class:`.BaseActivity`]
The activity being done. ``None`` if no activity is done.
activities: Optional[List[:class:`BaseActivity`]]
activities: Optional[List[:class:`.BaseActivity`]]
A list of the activities being done. ``None`` if no activities
are done. Cannot be sent with ``activity``.
status: Optional[:class:`.Status`]
@ -2134,7 +2134,7 @@ class Client:
async def notes(self) -> List[Note]:
"""|coro|
Retrieves a list of :class:`Note` objects representing all your notes.
Retrieves a list of :class:`.Note` objects representing all your notes.
.. versionadded:: 1.9
@ -2264,7 +2264,7 @@ class Client:
Parameters
-----------
\*recipients: :class:`~discord.abc.Snowflake`
An argument :class:`list` of :class:`.User` to have in
An argument :class:`list` of :class:`discord.User` to have in
your group.
Raises

3
discord/user.py

@ -141,7 +141,7 @@ class Note:
@cached_slot_property('_user')
def user(self) -> _Snowflake:
""":class:`Snowflake`: Returns the :class:`User` or :class:`Object` the note belongs to."""
""":class:`~abc.Snowflake`: Returns the :class:`User` or :class:`Object` the note belongs to."""
user_id = self._user_id
user = self._state.get_user(user_id)
@ -899,6 +899,7 @@ class User(BaseUser, discord.abc.Connectable, discord.abc.Messageable):
@property
def call(self) -> Optional[PrivateCall]:
"""Optional[:class:`PrivateCall`]: Returns the call associated with this user if it exists."""
return getattr(self.dm_channel, 'call', None)
@property

Loading…
Cancel
Save