Fix various inconsistencies within the documentation (#5067)

This commit is contained in:
Sebastian Law
2020-06-28 00:45:58 -07:00
committed by GitHub
parent f94b00cb48
commit b4b953bfc6
24 changed files with 378 additions and 142 deletions

View File

@ -338,7 +338,7 @@ class Game(BaseActivity):
@property
def type(self):
"""Returns the game's type. This is for compatibility with :class:`Activity`.
""":class:`ActivityType`: Returns the game's type. This is for compatibility with :class:`Activity`.
It always returns :attr:`ActivityType.playing`.
"""
@ -445,7 +445,7 @@ class Streaming(BaseActivity):
@property
def type(self):
"""Returns the game's type. This is for compatibility with :class:`Activity`.
""":class:`ActivityType`: Returns the game's type. This is for compatibility with :class:`Activity`.
It always returns :attr:`ActivityType.streaming`.
"""
@ -530,7 +530,7 @@ class Spotify:
@property
def type(self):
"""Returns the activity's type. This is for compatibility with :class:`Activity`.
""":class:`ActivityType`: Returns the activity's type. This is for compatibility with :class:`Activity`.
It always returns :attr:`ActivityType.listening`.
"""
@ -547,14 +547,14 @@ class Spotify:
@property
def colour(self):
"""Returns the Spotify integration colour, as a :class:`Colour`.
""":class:`Colour`: Returns the Spotify integration colour, as a :class:`Colour`.
There is an alias for this named :attr:`color`"""
return Colour(0x1db954)
@property
def color(self):
"""Returns the Spotify integration colour, as a :class:`Colour`.
""":class:`Colour`: Returns the Spotify integration colour, as a :class:`Colour`.
There is an alias for this named :attr:`colour`"""
return self.colour
@ -697,7 +697,7 @@ class CustomActivity(BaseActivity):
@property
def type(self):
"""Returns the activity's type. This is for compatibility with :class:`Activity`.
""":class:`ActivityType`: Returns the activity's type. This is for compatibility with :class:`Activity`.
It always returns :attr:`ActivityType.custom`.
"""