Browse Source

Revert "Rework documentation to not duplicate inherited members."

This reverts commit 96981210b3.
pull/1164/merge
Rapptz 7 years ago
parent
commit
860d6a9ace
  1. 18
      discord/channel.py
  2. 4
      discord/ext/commands/context.py
  3. 4
      discord/member.py
  4. 4
      discord/user.py
  5. 42
      docs/api.rst

18
discord/channel.py

@ -45,11 +45,6 @@ async def _single_delete_strategy(messages):
class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable): class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
"""Represents a Discord guild text channel. """Represents a Discord guild text channel.
**Inherited Classes**
- :class:`discord.abc.Messageable`
- :class:`discord.abc.GuildChannel`
.. container:: operations .. container:: operations
.. describe:: x == y .. describe:: x == y
@ -393,11 +388,6 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable):
class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable): class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable):
"""Represents a Discord guild voice channel. """Represents a Discord guild voice channel.
**Inherited Classes**
- :class:`discord.abc.Connectable`
- :class:`discord.abc.GuildChannel`
.. container:: operations .. container:: operations
.. describe:: x == y .. describe:: x == y
@ -625,10 +615,6 @@ class CategoryChannel(discord.abc.GuildChannel, Hashable):
class DMChannel(discord.abc.Messageable, Hashable): class DMChannel(discord.abc.Messageable, Hashable):
"""Represents a Discord direct message channel. """Represents a Discord direct message channel.
**Inherited Classes**
- :class:`discord.abc.Messageable`
.. container:: operations .. container:: operations
.. describe:: x == y .. describe:: x == y
@ -711,10 +697,6 @@ class DMChannel(discord.abc.Messageable, Hashable):
class GroupChannel(discord.abc.Messageable, Hashable): class GroupChannel(discord.abc.Messageable, Hashable):
"""Represents a Discord group channel. """Represents a Discord group channel.
**Inherited Classes**
- :class:`discord.abc.Messageable`
.. container:: operations .. container:: operations
.. describe:: x == y .. describe:: x == y

4
discord/ext/commands/context.py

@ -34,9 +34,7 @@ class Context(discord.abc.Messageable):
the invocation context. This class is not created manually and is instead the invocation context. This class is not created manually and is instead
passed around to commands as the first parameter. passed around to commands as the first parameter.
**Inherited Classes** This class implements the :class:`abc.Messageable` ABC.
- :class:`discord.abc.Messageable`
Attributes Attributes
----------- -----------

4
discord/member.py

@ -112,9 +112,7 @@ _BaseUser = discord.abc.User
class Member(discord.abc.Messageable, _BaseUser): class Member(discord.abc.Messageable, _BaseUser):
"""Represents a Discord member to a :class:`Guild`. """Represents a Discord member to a :class:`Guild`.
**Inherited Classes** This implements a lot of the functionality of :class:`User`.
- :class:`discord.abc.Messageable`
.. container:: operations .. container:: operations

4
discord/user.py

@ -479,10 +479,6 @@ class ClientUser(BaseUser):
class User(BaseUser, discord.abc.Messageable): class User(BaseUser, discord.abc.Messageable):
"""Represents a Discord user. """Represents a Discord user.
**Inherited Classes**
- :class:`discord.abc.Messageable`
.. container:: operations .. container:: operations
.. describe:: x == y .. describe:: x == y

42
docs/api.rst

@ -1846,6 +1846,7 @@ ClientUser
.. autoclass:: ClientUser() .. autoclass:: ClientUser()
:members: :members:
:inherited-members:
Relationship Relationship
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@ -1858,6 +1859,14 @@ User
.. autoclass:: User() .. autoclass:: User()
:members: :members:
:inherited-members:
:exclude-members: history, typing
.. autocomethod:: history
:async-for:
.. autocomethod:: typing
:async-with:
Attachment Attachment
~~~~~~~~~~~ ~~~~~~~~~~~
@ -1908,6 +1917,14 @@ Member
.. autoclass:: Member() .. autoclass:: Member()
:members: :members:
:inherited-members:
:exclude-members: history, typing
.. autocomethod:: history
:async-for:
.. autocomethod:: typing
:async-with:
Spotify Spotify
~~~~~~~~ ~~~~~~~~
@ -1944,31 +1961,56 @@ TextChannel
.. autoclass:: TextChannel() .. autoclass:: TextChannel()
:members: :members:
:inherited-members:
:exclude-members: history, typing
.. autocomethod:: history
:async-for:
.. autocomethod:: typing
:async-with:
VoiceChannel VoiceChannel
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. autoclass:: VoiceChannel() .. autoclass:: VoiceChannel()
:members: :members:
:inherited-members:
CategoryChannel CategoryChannel
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
.. autoclass:: CategoryChannel() .. autoclass:: CategoryChannel()
:members: :members:
:inherited-members:
DMChannel DMChannel
~~~~~~~~~ ~~~~~~~~~
.. autoclass:: DMChannel() .. autoclass:: DMChannel()
:members: :members:
:inherited-members:
:exclude-members: history, typing
.. autocomethod:: history
:async-for:
.. autocomethod:: typing
:async-with:
GroupChannel GroupChannel
~~~~~~~~~~~~ ~~~~~~~~~~~~
.. autoclass:: GroupChannel() .. autoclass:: GroupChannel()
:members: :members:
:inherited-members:
:exclude-members: history, typing
.. autocomethod:: history
:async-for:
.. autocomethod:: typing
:async-with:
Invite Invite

Loading…
Cancel
Save