anas/spotipy
1
0
Fork 0
mirror of https://github.com/spotipy-dev/spotipy.git synced 2026-06-19 09:13:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fixed and clarified docstrings for client.py (#820)

Browse Source 
* fixed docstring for current_user_following_users_function

* Edited docstrings for playlist_cover_image, user_playlist, user_playlist_replace_tracks, user_playlist_reorder_tracks functions

* expanded docstring description of playlist_change_details function to include changes to collaborative state and/or description
This commit is contained in:
kanari1 2022-06-18 15:20:37 -07:00 committed by GitHub
parent c6b56a658a
commit 6164dbb628
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
spotipy/client.py
View File

@ -688,7 +688,7 @@ class Spotify(object):
) )
def playlist_cover_image(self, playlist_id): def playlist_cover_image(self, playlist_id):
""" Get cover of a playlist. """ Get cover image of a playlist.
Parameters: Parameters:
- playlist_id - the playlist ID, URI or URL - playlist_id - the playlist ID, URI or URL
@ -717,7 +717,7 @@ class Spotify(object):
DeprecationWarning, DeprecationWarning,
) )
""" Gets playlist of a user """ Gets a single playlist of a user
Parameters: Parameters:
- user - the id of the user - user - the id of the user
@ -849,7 +849,7 @@ class Spotify(object):
return self.playlist_add_items(playlist_id, tracks, position) return self.playlist_add_items(playlist_id, tracks, position)
def user_playlist_replace_tracks(self, user, playlist_id, tracks): def user_playlist_replace_tracks(self, user, playlist_id, tracks):
""" Replace all tracks in a playlist """ Replace all tracks in a playlist for a user
Parameters: Parameters:
- user - the id of the user - user - the id of the user
@ -871,7 +871,7 @@ class Spotify(object):
range_length=1, range_length=1,
snapshot_id=None, snapshot_id=None,
): ):
""" Reorder tracks in a playlist """ Reorder tracks in a playlist from a user
Parameters: Parameters:
- user - the id of the user - user - the id of the user
@ -990,7 +990,8 @@ class Spotify(object):
collaborative=None, collaborative=None,
description=None, description=None,
): ):
""" Changes a playlist's name and/or public/private state """ Changes a playlist's name and/or public/private state,
collaborative state, and/or description
Parameters: Parameters:
- playlist_id - the id of the playlist - playlist_id - the id of the playlist
@ -1090,7 +1091,7 @@ class Spotify(object):
def playlist_remove_all_occurrences_of_items( def playlist_remove_all_occurrences_of_items(
self, playlist_id, items, snapshot_id=None self, playlist_id, items, snapshot_id=None
): ):
""" Removes all occurrences of the given tracks from the given playlist """ Removes all occurrences of the given tracks/episodes from the given playlist
Parameters: Parameters:
- playlist_id - the id of the playlist - playlist_id - the id of the playlist
@ -1393,7 +1394,7 @@ class Spotify(object):
) )
def current_user_following_users(self, ids=None): def current_user_following_users(self, ids=None):
""" Check if the current user is following certain artists """ Check if the current user is following certain users
Returns list of booleans respective to ids Returns list of booleans respective to ids