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

docs: Add intro to model API

Browse Source
This commit is contained in:
Stein Magnus Jodal 2010-03-13 20:50:51 +01:00
parent 94523c3660
commit 65bce46983
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/api/models.rst
View File

@ -1,18 +1,28 @@
*********************************************
:mod:`mopidy.models` -- Immutable data models
*********************************************
********************
:mod:`mopidy.models`
********************
These immutable data models are used for all data transfer within the Mopidy
backends and between the backends and the MPD frontend. All fields are optional
and immutable. In other words, they can only be set through the class
constructor during instance creation.
Data model relations
====================
.. digraph:: model_relations
Playlist -> Track [ label="has 0..n" ]
Track -> Album [ label="has 0..1" ]
Track -> Artist [ label="has 0..n" ]
Album -> Artist [ label="has 0..n" ]
Data model API
==============
.. automodule:: mopidy.models
:synopsis: Immutable data models.
:members:
:undoc-members:
Model relations
===============
.. digraph:: model_relations
Playlist -> Track [ label="has multiple" ]
Track -> Album [ label="has one" ]
Track -> Artist [ label="has multiple" ]
Album -> Artist [ label="has multiple" ]