docs: Review versionadded/versionchanged usage

Fixes #1166
This commit is contained in:
Stein Magnus Jodal 2015-07-22 11:30:19 +02:00
parent 6cb48f29ce
commit b32db58f72
4 changed files with 18 additions and 10 deletions

View File

@ -214,8 +214,8 @@ class TracklistController(object):
:type tlid: :class:`int` or :class:`None` :type tlid: :class:`int` or :class:`None`
:rtype: :class:`int` or :class:`None` :rtype: :class:`int` or :class:`None`
.. versionchanged:: 1.1 .. versionadded:: 1.1
Added the *tlid* parameter The *tlid* parameter
""" """
tl_track is None or validation.check_instance(tl_track, TlTrack) tl_track is None or validation.check_instance(tl_track, TlTrack)
tlid is None or validation.check_integer(tlid, min=0) tlid is None or validation.check_integer(tlid, min=0)

View File

@ -361,7 +361,8 @@ def rangeid(context, tlid, songrange):
everything". A song that is currently playing cannot be manipulated everything". A song that is currently playing cannot be manipulated
this way. this way.
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO 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 tags received from the server, and the data is gone when the song gets
removed from the queue. removed from the queue.
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO 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 tag values will be removed. Editing song tags is only possible for
remote songs. remote songs.
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO raise exceptions.MpdNotImplemented # TODO

View File

@ -14,7 +14,8 @@ def mount(context, path, uri):
mount foo nfs://192.168.1.4/export/mp3 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 raise exceptions.MpdNotImplemented # TODO
@ -30,7 +31,8 @@ def unmount(context, path):
unmount foo unmount foo
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO raise exceptions.MpdNotImplemented # TODO
@ -52,7 +54,8 @@ def listmounts(context):
storage: nfs://192.168.1.4/export/mp3 storage: nfs://192.168.1.4/export/mp3
OK OK
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO raise exceptions.MpdNotImplemented # TODO
@ -73,6 +76,7 @@ def listneighbors(context):
name: FOO (Samba 4.1.11-Debian) name: FOO (Samba 4.1.11-Debian)
OK OK
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO raise exceptions.MpdNotImplemented # TODO

View File

@ -359,7 +359,8 @@ def listfiles(context, uri=None):
SMB/CIFS server; "nfs://servername/path" obtains a directory listing SMB/CIFS server; "nfs://servername/path" obtains a directory listing
from the NFS server. from the NFS server.
.. versionadded:: MPD protocol 0.19 .. versionadded:: 0.19
New in MPD protocol version 0.19
""" """
raise exceptions.MpdNotImplemented # TODO raise exceptions.MpdNotImplemented # TODO