[PR #820] [MERGED] Fixed and clarified docstrings for client.py #1026

New issue

Closed

opened 2026-02-28 00:03:18 +03:00 by kerem · 0 comments

kerem commented

2026-02-28 00:03:18 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/820
Author: @kanari1
Created: 6/5/2022
Status: ✅ Merged
Merged: 6/18/2022
Merged by: @stephanebruckert

Base: master ← Head: master

📝 Commits (3)

d74d494 fixed docstring for current_user_following_users_function
f379a14 Edited docstrings for playlist_cover_image, user_playlist, user_playlist_replace_tracks, user_playlist_reorder_tracks functions
6081f9b expanded docstring description of playlist_change_details function to include changes to collaborative state and/or description

📊 Changes

1 file changed (+8 additions, -7 deletions)

View changed files

📝 spotipy/client.py (+8 -7)

📄 Description

There were some confusing semantics and errors in the docstrings for the functions in spotipy/client.py files, so I clarified and fixed some of the errors in those docstrings.

Fixed docstring for current_user_following_users function to correctly state that it checks if the current user is following certain users, not certain artists
Expanded docstring for playlist_change_details function to also include that changes can be made to the collaborative state and description
Made semantical edits to clarify certain docstrings

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/spotipy-dev/spotipy/pull/820 **Author:** [@kanari1](https://github.com/kanari1) **Created:** 6/5/2022 **Status:** ✅ Merged **Merged:** 6/18/2022 **Merged by:** [@stephanebruckert](https://github.com/stephanebruckert) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (3) - [`d74d494`](https://github.com/spotipy-dev/spotipy/commit/d74d4945e64d8464fdb60cbdb4e030f514b6d06c) fixed docstring for current_user_following_users_function - [`f379a14`](https://github.com/spotipy-dev/spotipy/commit/f379a14a8bca741b9c37d16dc5c99fe6d95a0849) Edited docstrings for playlist_cover_image, user_playlist, user_playlist_replace_tracks, user_playlist_reorder_tracks functions - [`6081f9b`](https://github.com/spotipy-dev/spotipy/commit/6081f9ba8311dc70a864adbe76c6a33dc5dcdc3e) expanded docstring description of playlist_change_details function to include changes to collaborative state and/or description ### 📊 Changes **1 file changed** (+8 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `spotipy/client.py` (+8 -7) </details> ### 📄 Description There were some confusing semantics and errors in the docstrings for the functions in spotipy/client.py files, so I clarified and fixed some of the errors in those docstrings. - Fixed docstring for current_user_following_users function to correctly state that it checks if the current user is following certain users, not certain artists - Expanded docstring for playlist_change_details function to also include that changes can be made to the collaborative state and description - Made semantical edits to clarify certain docstrings --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>