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

history: Cleanup docstrings

Browse Source
This commit is contained in:
Stein Magnus Jodal 2014-09-23 18:44:17 +02:00
parent d30cf68efd
commit 1f1e86023b
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
mopidy/core/history.py
View File

@ -16,8 +16,9 @@ class HistoryController(object):
self._history = []
def add(self, track):
"""
:param track: track to change to
"""Add track to the playback history.
:param track: track to add
:type track: :class:`mopidy.models.Track`
"""
if not isinstance(track, models.Track):
@ -39,17 +40,17 @@ class HistoryController(object):
@property
def size(self):
"""
Returns the number of tracks in the history.
:returns: The number of tracks in the history.
:rtype :int
"""Get the number of tracks in the history.
:returns: the history length
:rtype: int
"""
return len(self._history)
def get_history(self):
"""
Returns the history.
:returns: The history as a list of `mopidy.models.Track`
:rtype: L{`mopidy.models.Track`}
"""Get the track history.
:returns: the track history
:rtype: list of (timestamp, mopidy.models.Ref) tuples
"""
return copy.copy(self._history)