andpp/mopidy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Documenting further the TracklistController functions

Browse Source
This commit is contained in:
Javier Domingo Cansino 2013-08-13 09:17:21 +02:00
parent 21f3a8784a
commit 157556a001
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
mopidy/core/tracklist.py
View File

@ -136,6 +136,10 @@ class TracklistController(object):
def index(self, tl_track): def index(self, tl_track):
""" """
The position of the given track in the tracklist. The position of the given track in the tracklist.
:param tl_track: The reference track
:type tl_track: :class:`mopidy.models.TlTrack`
:rtype: int
""" """
if tl_track is None: if tl_track is None:
return None return None
@ -152,6 +156,7 @@ class TracklistController(object):
:param tl_track: The reference track :param tl_track: The reference track
:type tl_track: :class:`mopidy.models.TlTrack` :type tl_track: :class:`mopidy.models.TlTrack`
:rtype: :class:`mopidy.models.TlTrack`
""" """
# pylint: disable = R0911 # pylint: disable = R0911
# Too many return statements # Too many return statements
@ -196,6 +201,7 @@ class TracklistController(object):
:param tl_track: The reference track :param tl_track: The reference track
:type tl_track: :class:`mopidy.models.TlTrack` :type tl_track: :class:`mopidy.models.TlTrack`
:rtype: :class:`mopidy.models.TlTrack`
""" """
if not self.tl_tracks: if not self.tl_tracks:
@ -236,6 +242,7 @@ class TracklistController(object):
:param tl_track: The reference track :param tl_track: The reference track
:type tl_track: :class:`mopidy.models.TlTrack` :type tl_track: :class:`mopidy.models.TlTrack`
:rtype: :class:`mopidy.models.TlTrack`
""" """
if self.repeat or self.consume or self.random: if self.repeat or self.consume or self.random:
return tl_track return tl_track