diff options
| author | Rapptz <[email protected]> | 2018-10-03 05:45:30 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2018-10-03 05:45:30 -0400 |
| commit | 96981210b3415e15446db0b702b07fef25c8b680 (patch) | |
| tree | 82bc7406d30a66d583dab33dfbb0269ab9d3a4d2 | |
| parent | Add note regarding MORE_EMOJI in Guild.create_custom_emoji (diff) | |
| download | discord.py-96981210b3415e15446db0b702b07fef25c8b680.tar.xz discord.py-96981210b3415e15446db0b702b07fef25c8b680.zip | |
Rework documentation to not duplicate inherited members.
This will probably be reverted in 1 week.
| -rw-r--r-- | discord/channel.py | 18 | ||||
| -rw-r--r-- | discord/ext/commands/context.py | 4 | ||||
| -rw-r--r-- | discord/member.py | 4 | ||||
| -rw-r--r-- | discord/user.py | 4 | ||||
| -rw-r--r-- | docs/api.rst | 42 |
5 files changed, 28 insertions, 44 deletions
diff --git a/discord/channel.py b/discord/channel.py index 30e2369c..3d330a43 100644 --- a/discord/channel.py +++ b/discord/channel.py @@ -45,6 +45,11 @@ async def _single_delete_strategy(messages): class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable): """Represents a Discord guild text channel. + **Inherited Classes** + + - :class:`discord.abc.Messageable` + - :class:`discord.abc.GuildChannel` + .. container:: operations .. describe:: x == y @@ -388,6 +393,11 @@ class TextChannel(discord.abc.Messageable, discord.abc.GuildChannel, Hashable): class VoiceChannel(discord.abc.Connectable, discord.abc.GuildChannel, Hashable): """Represents a Discord guild voice channel. + **Inherited Classes** + + - :class:`discord.abc.Connectable` + - :class:`discord.abc.GuildChannel` + .. container:: operations .. describe:: x == y @@ -615,6 +625,10 @@ class CategoryChannel(discord.abc.GuildChannel, Hashable): class DMChannel(discord.abc.Messageable, Hashable): """Represents a Discord direct message channel. + **Inherited Classes** + + - :class:`discord.abc.Messageable` + .. container:: operations .. describe:: x == y @@ -697,6 +711,10 @@ class DMChannel(discord.abc.Messageable, Hashable): class GroupChannel(discord.abc.Messageable, Hashable): """Represents a Discord group channel. + **Inherited Classes** + + - :class:`discord.abc.Messageable` + .. container:: operations .. describe:: x == y diff --git a/discord/ext/commands/context.py b/discord/ext/commands/context.py index 73679e52..3130d56f 100644 --- a/discord/ext/commands/context.py +++ b/discord/ext/commands/context.py @@ -34,7 +34,9 @@ class Context(discord.abc.Messageable): the invocation context. This class is not created manually and is instead passed around to commands as the first parameter. - This class implements the :class:`abc.Messageable` ABC. + **Inherited Classes** + + - :class:`discord.abc.Messageable` Attributes ----------- diff --git a/discord/member.py b/discord/member.py index f265a1be..f18fe168 100644 --- a/discord/member.py +++ b/discord/member.py @@ -112,7 +112,9 @@ _BaseUser = discord.abc.User class Member(discord.abc.Messageable, _BaseUser): """Represents a Discord member to a :class:`Guild`. - This implements a lot of the functionality of :class:`User`. + **Inherited Classes** + + - :class:`discord.abc.Messageable` .. container:: operations diff --git a/discord/user.py b/discord/user.py index 07a17369..0b7b9859 100644 --- a/discord/user.py +++ b/discord/user.py @@ -479,6 +479,10 @@ class ClientUser(BaseUser): class User(BaseUser, discord.abc.Messageable): """Represents a Discord user. + **Inherited Classes** + + - :class:`discord.abc.Messageable` + .. container:: operations .. describe:: x == y diff --git a/docs/api.rst b/docs/api.rst index 7fe668d5..aca4fe49 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1846,7 +1846,6 @@ ClientUser .. autoclass:: ClientUser() :members: - :inherited-members: Relationship ~~~~~~~~~~~~~~ @@ -1859,14 +1858,6 @@ User .. autoclass:: User() :members: - :inherited-members: - :exclude-members: history, typing - - .. autocomethod:: history - :async-for: - - .. autocomethod:: typing - :async-with: Attachment ~~~~~~~~~~~ @@ -1917,14 +1908,6 @@ Member .. autoclass:: Member() :members: - :inherited-members: - :exclude-members: history, typing - - .. autocomethod:: history - :async-for: - - .. autocomethod:: typing - :async-with: Spotify ~~~~~~~~ @@ -1961,56 +1944,31 @@ TextChannel .. autoclass:: TextChannel() :members: - :inherited-members: - :exclude-members: history, typing - - .. autocomethod:: history - :async-for: - - .. autocomethod:: typing - :async-with: VoiceChannel ~~~~~~~~~~~~~ .. autoclass:: VoiceChannel() :members: - :inherited-members: CategoryChannel ~~~~~~~~~~~~~~~~~ .. autoclass:: CategoryChannel() :members: - :inherited-members: DMChannel ~~~~~~~~~ .. autoclass:: DMChannel() :members: - :inherited-members: - :exclude-members: history, typing - - .. autocomethod:: history - :async-for: - .. autocomethod:: typing - :async-with: GroupChannel ~~~~~~~~~~~~ .. autoclass:: GroupChannel() :members: - :inherited-members: - :exclude-members: history, typing - - .. autocomethod:: history - :async-for: - - .. autocomethod:: typing - :async-with: Invite |