From 52c61634f5e1b2782940eb9b41d4223b15859ac2 Mon Sep 17 00:00:00 2001
From: Thomas Adamcik <adamcik@samfundet.no>
Date: Sat, 30 Oct 2010 21:57:33 +0200
Subject: [PATCH] Add doc that explains why on earth order_mpd_track_info is
 used

---
 mopidy/frontends/mpd/translator.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/mopidy/frontends/mpd/translator.py b/mopidy/frontends/mpd/translator.py
index b139967c..96edae49 100644
--- a/mopidy/frontends/mpd/translator.py
+++ b/mopidy/frontends/mpd/translator.py
@@ -53,6 +53,15 @@ MPD_KEY_ORDER = '''
 '''.split()
 
 def order_mpd_track_info(result):
+    """
+    Order results from :func:`mopidy.frontends.mpd.translator.track_to_mpd_format`
+    so that it matches MPD's ordering. Simply a cosmetic fix for easier
+    diffing of tag_caches.
+
+    :param result: the track info
+    :type result: list of tuples
+    :rtype: list of tuples
+    """
     return sorted(result, key=lambda i: MPD_KEY_ORDER.index(i[0]))
 
 def artists_to_mpd_format(artists):