From 46bb780a4632967e78e329592e5c18dd20e55c43 Mon Sep 17 00:00:00 2001
From: Jens Luetjen <dublok@users.noreply.github.com>
Date: Sat, 9 Jan 2016 11:46:09 +0100
Subject: [PATCH] Rename TracklistState 'tracks' to 'tl_tracks'

Correct documentation.
---
 mopidy/core/tracklist.py     |  4 ++--
 mopidy/models/__init__.py    | 10 +++++++---
 tests/core/test_tracklist.py |  8 ++++----
 tests/models/test_models.py  |  8 ++++----
 4 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/mopidy/core/tracklist.py b/mopidy/core/tracklist.py
index cc3b8bef..50068d92 100644
--- a/mopidy/core/tracklist.py
+++ b/mopidy/core/tracklist.py
@@ -648,7 +648,7 @@ class TracklistController(object):
     def _export_state(self):
         """Internal method for :class:`mopidy.Core`."""
         return TracklistState(
-            tracks=self._tl_tracks,
+            tl_tracks=self._tl_tracks,
             next_tlid=self._next_tlid,
             consume=self.get_consume(),
             random=self.get_random(),
@@ -669,6 +669,6 @@ class TracklistController(object):
                 if state.next_tlid > self._next_tlid:
                     self._next_tlid = state.next_tlid
                 self._tl_tracks = []
-                for track in state.tracks:
+                for track in state.tl_tracks:
                     self._tl_tracks.append(track)
                 self._trigger_tracklist_changed()
diff --git a/mopidy/models/__init__.py b/mopidy/models/__init__.py
index 5a980866..eb396e05 100644
--- a/mopidy/models/__init__.py
+++ b/mopidy/models/__init__.py
@@ -374,14 +374,14 @@ class HistoryTrack(ValidatedImmutableObject):
 
     :param timestamp: the timestamp
     :type timestamp: int
-    :param track: the track
+    :param track: the track reference
     :type track: :class:`Ref`
     """
 
     # The timestamp. Read-only.
     timestamp = fields.Integer()
 
-    # The track. Read-only.
+    # The track reference. Read-only.
     track = fields.Field(type=Ref)
 
 
@@ -448,6 +448,10 @@ class TracklistState(ValidatedImmutableObject):
     :type random: bool
     :param single: the single mode
     :type single: bool
+    :param next_tlid: the single mode
+    :type next_tlid: bool
+    :param tl_tracks: the single mode
+    :type tl_tracks: list of :class:`TlTrack`
     """
 
     # The repeat mode. Read-only.
@@ -466,4 +470,4 @@ class TracklistState(ValidatedImmutableObject):
     next_tlid = fields.Integer(min=0)
 
     # The list of tracks. Read-only.
-    tracks = fields.Collection(type=TlTrack, container=tuple)
+    tl_tracks = fields.Collection(type=TlTrack, container=tuple)
diff --git a/tests/core/test_tracklist.py b/tests/core/test_tracklist.py
index 59f78d01..40de840b 100644
--- a/tests/core/test_tracklist.py
+++ b/tests/core/test_tracklist.py
@@ -221,7 +221,7 @@ class TracklistExportRestoreTest(unittest.TestCase):
                                 single=False,
                                 random=False,
                                 next_tlid=next_tlid,
-                                tracks=tl_tracks)
+                                tl_tracks=tl_tracks)
         value = self.core.tracklist._export_state()
         self.assertEqual(target, value)
 
@@ -231,7 +231,7 @@ class TracklistExportRestoreTest(unittest.TestCase):
                                 single=True,
                                 random=False,
                                 next_tlid=12,
-                                tracks=self.tl_tracks)
+                                tl_tracks=self.tl_tracks)
         coverage = ['mode', 'tracklist']
         self.core.tracklist._restore_state(target, coverage)
         self.assertEqual(False, self.core.tracklist.get_consume())
@@ -253,7 +253,7 @@ class TracklistExportRestoreTest(unittest.TestCase):
                                 single=True,
                                 random=False,
                                 next_tlid=12,
-                                tracks=self.tl_tracks)
+                                tl_tracks=self.tl_tracks)
         coverage = ['mode']
         self.core.tracklist._restore_state(target, coverage)
         self.assertEqual(False, self.core.tracklist.get_consume())
@@ -270,7 +270,7 @@ class TracklistExportRestoreTest(unittest.TestCase):
                                 single=True,
                                 random=False,
                                 next_tlid=12,
-                                tracks=self.tl_tracks)
+                                tl_tracks=self.tl_tracks)
         coverage = ['tracklist']
         self.core.tracklist._restore_state(target, coverage)
         self.assertEqual(False, self.core.tracklist.get_consume())
diff --git a/tests/models/test_models.py b/tests/models/test_models.py
index 1bf2b1fb..0281fd65 100644
--- a/tests/models/test_models.py
+++ b/tests/models/test_models.py
@@ -1321,12 +1321,12 @@ class TracklistStateTest(unittest.TestCase):
 
     def test_tracks(self):
         tracks = (TlTrack(), TlTrack())
-        result = TracklistState(tracks=tracks)
-        self.assertEqual(result.tracks, tracks)
+        result = TracklistState(tl_tracks=tracks)
+        self.assertEqual(result.tl_tracks, tracks)
         with self.assertRaises(AttributeError):
-            result.tracks = None
+            result.tl_tracks = None
 
     def test_tracks_invalid(self):
         tracks = (Track(), Track())
         with self.assertRaises(TypeError):
-            TracklistState(tracks=tracks)
+            TracklistState(tl_tracks=tracks)