From 4e0c1ce93fa4ef7881eb33cc8e10cc8d689173e0 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 1 Nov 2010 23:52:21 +0100 Subject: [PATCH] docs: Improve playback provider docs --- mopidy/backends/base/playback.py | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/mopidy/backends/base/playback.py b/mopidy/backends/base/playback.py index 8b935c65..1ab8aeda 100644 --- a/mopidy/backends/base/playback.py +++ b/mopidy/backends/base/playback.py @@ -504,8 +504,9 @@ class BasePlaybackProvider(object): def pause(self): """ - To be overridden by subclass. Implement your backend's pause - functionality here. + To be overridden by subclass. + + Pause playback. :rtype: :class:`True` if successful, else :class:`False` """ @@ -513,8 +514,9 @@ class BasePlaybackProvider(object): def play(self, track): """ - To be overridden by subclass. Implement your backend's play - functionality here. + To be overridden by subclass. + + Play given track. :param track: the track to play :type track: :class:`mopidy.models.Track` @@ -524,8 +526,9 @@ class BasePlaybackProvider(object): def resume(self): """ - To be overridden by subclass. Implement your backend's resume - functionality here. + To be overridden by subclass. + + Resume playback at the same time position playback was paused. :rtype: :class:`True` if successful, else :class:`False` """ @@ -533,8 +536,9 @@ class BasePlaybackProvider(object): def seek(self, time_position): """ - To be overridden by subclass. Implement your backend's seek - functionality here. + To be overridden by subclass. + + Seek to a given time position. :param time_position: time position in milliseconds :type time_position: int @@ -544,8 +548,9 @@ class BasePlaybackProvider(object): def stop(self): """ - To be overridden by subclass. Implement your backend's stop - functionality here. + To be overridden by subclass. + + Stop playback. :rtype: :class:`True` if successful, else :class:`False` """