models: Add description of Ref model

2013-12-29 21:08:46 +01:00 · 2013-12-29 21:08:46 +01:00 · d3dcceefc5
commit d3dcceefc5
parent e87d5729e3
1 changed files with 4 additions and 0 deletions
--- a/mopidy/models.py
+++ b/mopidy/models.py
@ -138,6 +138,10 @@ def model_json_decoder(dct):

 class Ref(ImmutableObject):
    """
+    Model to represent URI references with a human friendly name and type
+    attached. This is intended for use a lightweight object "free" of metadata
+    that can be passed around instead of using full blown models.
+
    :param uri: object URI
    :type uri: string
    :param name: object name