From 3d6270ad3772d464aac334faa27209ef690da38c Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 10 Jan 2016 07:41:50 +0100 Subject: [PATCH] docs: Document model's attributes Fixes #1385 --- docs/api/models.rst | 8 ++++++++ mopidy/models/__init__.py | 8 ++++---- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/api/models.rst b/docs/api/models.rst index 27c7647f..cc8518ba 100644 --- a/docs/api/models.rst +++ b/docs/api/models.rst @@ -55,20 +55,28 @@ Data model API :synopsis: Data model API .. autoclass:: mopidy.models.Ref + :members: .. autoclass:: mopidy.models.Track + :members: .. autoclass:: mopidy.models.Album + :members: .. autoclass:: mopidy.models.Artist + :members: .. autoclass:: mopidy.models.Playlist + :members: .. autoclass:: mopidy.models.Image + :members: .. autoclass:: mopidy.models.TlTrack + :members: .. autoclass:: mopidy.models.SearchResult + :members: Data model helpers diff --git a/mopidy/models/__init__.py b/mopidy/models/__init__.py index 7afa2db8..1ea23be0 100644 --- a/mopidy/models/__init__.py +++ b/mopidy/models/__init__.py @@ -348,14 +348,14 @@ class SearchResult(ValidatedImmutableObject): :type albums: list of :class:`Album` elements """ - # The search result URI. Read-only. + #: The search result URI. Read-only. uri = fields.URI() - # The tracks matching the search query. Read-only. + #: The tracks matching the search query. Read-only. tracks = fields.Collection(type=Track, container=tuple) - # The artists matching the search query. Read-only. + #: The artists matching the search query. Read-only. artists = fields.Collection(type=Artist, container=tuple) - # The albums matching the search query. Read-only. + #: The albums matching the search query. Read-only. albums = fields.Collection(type=Album, container=tuple)