From b32db58f729447e82fb2aee83eb23c0aec87dea3 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Wed, 22 Jul 2015 11:30:19 +0200 Subject: [PATCH] docs: Review versionadded/versionchanged usage Fixes #1166 --- mopidy/core/tracklist.py | 4 ++-- mopidy/mpd/protocol/current_playlist.py | 9 ++++++--- mopidy/mpd/protocol/mount.py | 12 ++++++++---- mopidy/mpd/protocol/music_db.py | 3 ++- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/mopidy/core/tracklist.py b/mopidy/core/tracklist.py index 63a38eae..1938f001 100644 --- a/mopidy/core/tracklist.py +++ b/mopidy/core/tracklist.py @@ -214,8 +214,8 @@ class TracklistController(object): :type tlid: :class:`int` or :class:`None` :rtype: :class:`int` or :class:`None` - .. versionchanged:: 1.1 - Added the *tlid* parameter + .. versionadded:: 1.1 + The *tlid* parameter """ tl_track is None or validation.check_instance(tl_track, TlTrack) tlid is None or validation.check_integer(tlid, min=0) diff --git a/mopidy/mpd/protocol/current_playlist.py b/mopidy/mpd/protocol/current_playlist.py index f9de250a..0d07452c 100644 --- a/mopidy/mpd/protocol/current_playlist.py +++ b/mopidy/mpd/protocol/current_playlist.py @@ -361,7 +361,8 @@ def rangeid(context, tlid, songrange): everything". A song that is currently playing cannot be manipulated this way. - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO @@ -437,7 +438,8 @@ def addtagid(context, tlid, tag, value): tags received from the server, and the data is gone when the song gets removed from the queue. - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO @@ -453,6 +455,7 @@ def cleartagid(context, tlid, tag): tag values will be removed. Editing song tags is only possible for remote songs. - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO diff --git a/mopidy/mpd/protocol/mount.py b/mopidy/mpd/protocol/mount.py index bb9e7ed6..f9a0d75f 100644 --- a/mopidy/mpd/protocol/mount.py +++ b/mopidy/mpd/protocol/mount.py @@ -14,7 +14,8 @@ def mount(context, path, uri): mount foo nfs://192.168.1.4/export/mp3 - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO @@ -30,7 +31,8 @@ def unmount(context, path): unmount foo - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO @@ -52,7 +54,8 @@ def listmounts(context): storage: nfs://192.168.1.4/export/mp3 OK - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO @@ -73,6 +76,7 @@ def listneighbors(context): name: FOO (Samba 4.1.11-Debian) OK - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO diff --git a/mopidy/mpd/protocol/music_db.py b/mopidy/mpd/protocol/music_db.py index e51a7e22..00db0218 100644 --- a/mopidy/mpd/protocol/music_db.py +++ b/mopidy/mpd/protocol/music_db.py @@ -359,7 +359,8 @@ def listfiles(context, uri=None): SMB/CIFS server; "nfs://servername/path" obtains a directory listing from the NFS server. - .. versionadded:: MPD protocol 0.19 + .. versionadded:: 0.19 + New in MPD protocol version 0.19 """ raise exceptions.MpdNotImplemented # TODO