Fixed some playlist functions docstrings (#732)

playlist_items(), playlist_cover_image() functions can take ID, URI or URL. Current docstring only mentions ID. This can also be verified and tested out. Example in examples folder also uses URI with playlist_items().
This commit is contained in:
Yash 2021-10-01 02:31:12 +05:30 committed by GitHub
parent 48d04f343b
commit a81aa595ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -633,7 +633,7 @@ class Spotify(object):
""" Get full details of the tracks of a playlist. """ Get full details of the tracks of a playlist.
Parameters: Parameters:
- playlist_id - the id of the playlist - playlist_id - the playlist ID, URI or URL
- fields - which fields to return - fields - which fields to return
- limit - the maximum number of tracks to return - limit - the maximum number of tracks to return
- offset - the index of the first track to return - offset - the index of the first track to return
@ -661,7 +661,7 @@ class Spotify(object):
""" Get full details of the tracks and episodes of a playlist. """ Get full details of the tracks and episodes of a playlist.
Parameters: Parameters:
- playlist_id - the id of the playlist - playlist_id - the playlist ID, URI or URL
- fields - which fields to return - fields - which fields to return
- limit - the maximum number of tracks to return - limit - the maximum number of tracks to return
- offset - the index of the first track to return - offset - the index of the first track to return
@ -683,7 +683,7 @@ class Spotify(object):
""" Get cover of a playlist. """ Get cover of a playlist.
Parameters: Parameters:
- playlist_id - the id of the playlist - playlist_id - the playlist ID, URI or URL
""" """
plid = self._get_id("playlist", playlist_id) plid = self._get_id("playlist", playlist_id)
return self._get("playlists/%s/images" % (plid)) return self._get("playlists/%s/images" % (plid))