From 157556a001065eefd287c78dbe11e52402567c87 Mon Sep 17 00:00:00 2001 From: Javier Domingo Cansino Date: Tue, 13 Aug 2013 09:17:21 +0200 Subject: [PATCH] docs: Documenting further the TracklistController functions --- mopidy/core/tracklist.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mopidy/core/tracklist.py b/mopidy/core/tracklist.py index ebac89e8..135f3e73 100644 --- a/mopidy/core/tracklist.py +++ b/mopidy/core/tracklist.py @@ -136,6 +136,10 @@ class TracklistController(object): def index(self, tl_track): """ 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: return None @@ -152,6 +156,7 @@ class TracklistController(object): :param tl_track: The reference track :type tl_track: :class:`mopidy.models.TlTrack` + :rtype: :class:`mopidy.models.TlTrack` """ # pylint: disable = R0911 # Too many return statements @@ -196,6 +201,7 @@ class TracklistController(object): :param tl_track: The reference track :type tl_track: :class:`mopidy.models.TlTrack` + :rtype: :class:`mopidy.models.TlTrack` """ if not self.tl_tracks: @@ -236,6 +242,7 @@ class TracklistController(object): :param tl_track: The reference track :type tl_track: :class:`mopidy.models.TlTrack` + :rtype: :class:`mopidy.models.TlTrack` """ if self.repeat or self.consume or self.random: return tl_track