Skip to content

Commit 907f920

Browse files
committed
docs: Make it more clear what each part of core does right away
1 parent 0afe8ef commit 907f920

1 file changed

Lines changed: 24 additions & 26 deletions

File tree

docs/api/core.rst

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,44 @@ as a Pykka actor.
1414

1515
.. autoclass:: mopidy.core.Core
1616

17-
.. automethod:: get_uri_schemes
17+
.. attribute:: tracklist
1818

19-
.. automethod:: get_version
19+
Manages everything related to the list of tracks we will play.
20+
See :class:`~mopidy.core.TracklistController`.
21+
22+
.. attribute:: playback
23+
24+
Manages playback state and the current playing track.
25+
See :class:`~mopidy.core.PlaybackController`.
2026

21-
.. autoattribute:: tracklist
22-
:annotation:
27+
.. attribute:: library
2328

24-
.. autoattribute:: playback
25-
:annotation:
29+
Manages the music library, e.g. searching and browsing for music.
30+
See :class:`~mopidy.core.LibraryController`.
2631

27-
.. autoattribute:: library
28-
:annotation:
32+
.. attribute:: playlists
2933

30-
.. autoattribute:: playlists
31-
:annotation:
34+
Manages stored playlists. See :class:`~mopidy.core.PlaylistsController`.
3235

33-
.. autoattribute:: mixer
34-
:annotation:
36+
.. attribute:: mixer
3537

36-
.. autoattribute:: history
37-
:annotation:
38+
Manages volume and muting. See :class:`~mopidy.core.MixerController`.
39+
40+
.. attribute:: history
41+
42+
Keeps record of what tracks have been played.
43+
See :class:`~mopidy.core.HistoryController`.
44+
45+
.. automethod:: get_uri_schemes
46+
47+
.. automethod:: get_version
3848

3949

4050
Tracklist controller
4151
====================
4252

4353
.. autoclass:: mopidy.core.TracklistController
4454

45-
Manages everything related to the tracks we are currently playing. This is
46-
likely where you need to start as only tracks that are in the *tracklist* can be
47-
played.
48-
4955
Manipulating
5056
------------
5157

@@ -107,35 +113,27 @@ seek, and volume control.
107113
History controller
108114
==================
109115

110-
Keeps record of what tracks have been played.
111-
112116
.. autoclass:: mopidy.core.HistoryController
113117
:members:
114118

115119

116120
Playlists controller
117121
====================
118122

119-
Manages persistence of playlists.
120-
121123
.. autoclass:: mopidy.core.PlaylistsController
122124
:members:
123125

124126

125127
Library controller
126128
==================
127129

128-
Manages the music library, e.g. searching for tracks to be added to a playlist.
129-
130130
.. autoclass:: mopidy.core.LibraryController
131131
:members:
132132

133133

134134
Mixer controller
135135
================
136136

137-
Manages volume and muting.
138-
139137
.. autoclass:: mopidy.core.MixerController
140138
:members:
141139

0 commit comments

Comments
 (0)