Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed and clarified docstrings for client.py #820

Merged
merged 3 commits into from Jun 18, 2022
Merged

Fixed and clarified docstrings for client.py #820

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d74d494
fixed docstring for current_user_following_users_function
kanari1 Jun 5, 2022
f379a14
Edited docstrings for playlist_cover_image, user_playlist, user_playl…
kanari1 Jun 5, 2022
6081f9b
expanded docstring description of playlist_change_details function to…
kanari1 Jun 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 8 additions & 7 deletions spotipy/client.py
View file
Open in desktop
Expand Up @@ -680,7 +680,7 @@ def playlist_items(
)

def playlist_cover_image(self, playlist_id):
""" Get cover of a playlist.
""" Get cover image of a playlist.

Parameters:
- playlist_id - the playlist ID, URI or URL
Expand Down Expand Up @@ -709,7 +709,7 @@ def user_playlist(self, user, playlist_id=None, fields=None, market=None):
DeprecationWarning,
)

""" Gets playlist of a user
""" Gets a single playlist of a user

Parameters:
- user - the id of the user
Expand Down Expand Up @@ -841,7 +841,7 @@ def user_playlist_add_tracks(
return self.playlist_add_items(playlist_id, tracks, position)

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:
- user - the id of the user
Expand All @@ -863,7 +863,7 @@ def user_playlist_reorder_tracks(
range_length=1,
snapshot_id=None,
):
""" Reorder tracks in a playlist
""" Reorder tracks in a playlist from a user

Parameters:
- user - the id of the user
Expand Down Expand Up @@ -982,7 +982,8 @@ def playlist_change_details(
collaborative=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:
- playlist_id - the id of the playlist
Expand Down Expand Up @@ -1082,7 +1083,7 @@ def playlist_reorder_items(
def playlist_remove_all_occurrences_of_items(
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:
- playlist_id - the id of the playlist
Expand Down Expand Up @@ -1385,7 +1386,7 @@ def current_user_following_artists(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

Expand Down