More doc string clean up

This commit is contained in:
JonnyWong16 2020-12-23 22:24:46 -08:00
parent 3430c245e2
commit f41be90a3a
No known key found for this signature in database
GPG key ID: B1F1F9807184697A
3 changed files with 8 additions and 8 deletions

View file

@ -7,8 +7,8 @@ from plexapi.exceptions import BadRequest
class Audio(PlexPartialObject):
""" Base class for audio :class:`~plexapi.audio.Artist`, :class:`~plexapi.audio.Album`
and :class:`~plexapi.audio.Track` objects.
""" Base class for all audio objects including :class:`~plexapi.audio.Artist`,
:class:`~plexapi.audio.Album`, and :class:`~plexapi.audio.Track`.
Attributes:
addedAt (datetime): Datetime the item was added to the library.
@ -124,7 +124,7 @@ class Audio(PlexPartialObject):
@utils.registerPlexObject
class Artist(Audio):
""" Represents a single audio artist.
""" Represents a single Artist.
Attributes:
TAG (str): 'Directory'
@ -218,7 +218,7 @@ class Artist(Audio):
@utils.registerPlexObject
class Album(Audio):
""" Represents a single audio album.
""" Represents a single Album.
Attributes:
TAG (str): 'Directory'
@ -324,7 +324,7 @@ class Album(Audio):
@utils.registerPlexObject
class Track(Audio, Playable):
""" Represents a single audio track.
""" Represents a single Track.
Attributes:
TAG (str): 'Directory'

View file

@ -8,7 +8,7 @@ from plexapi.exceptions import BadRequest
@utils.registerPlexObject
class Photoalbum(PlexPartialObject):
""" Represents a photoalbum (collection of photos).
""" Represents a single Photoalbum (collection of photos).
Attributes:
TAG (str): 'Directory'
@ -137,7 +137,7 @@ class Photoalbum(PlexPartialObject):
@utils.registerPlexObject
class Photo(PlexPartialObject, Playable):
""" Represents a single photo.
""" Represents a single Photo.
Attributes:
TAG (str): 'Photo'

View file

@ -10,7 +10,7 @@ from plexapi.exceptions import BadRequest, NotFound
class Video(PlexPartialObject):
""" Base class for all video objects including :class:`~plexapi.video.Movie`,
:class:`~plexapi.video.Show`, :class:`~plexapi.video.Season`,
:class:`~plexapi.video.Episode`, :class:`~plexapi.video.Clip`.
:class:`~plexapi.video.Episode`, and :class:`~plexapi.video.Clip`.
Attributes:
addedAt (datetime): Datetime the item was added to the library.