[PR #1129] [CLOSED] Added function docstrings for util.py #1172

Closed
opened 2026-02-28 00:03:56 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/spotipy-dev/spotipy/pull/1129
Author: @dianna-SE
Created: 6/3/2024
Status: Closed

Base: masterHead: update-util-docstrings


📝 Commits (4)

  • d5d2a06 Added function docstrings for util.py that includes arguments, returns, and raises. The prompt_for_user_token function docstring is revised for clarity.
  • 1a2e039 updating .gitignore and adding api credentials
  • d7ebb83 Merge branch 'master' into update-util-docstrings
  • 354c811 Added function docstrings for util.py that includes arguments, returns, and raises. The prompt_for_user_token function docstring is revised for clarity.

📊 Changes

3 files changed (+65 additions, -17 deletions)

View changed files

📝 .gitignore (+4 -1)
📝 CHANGELOG.md (+8 -0)
📝 spotipy/util.py (+53 -16)

📄 Description

Added function docstrings for util.py that include arguments, returns, and raises according to the standard styling guidelines. The prompt_for_user_token function docstring is revised for clarity—credits to dieser-niko for the helpful explanation of the functions.


🔄 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/1129 **Author:** [@dianna-SE](https://github.com/dianna-SE) **Created:** 6/3/2024 **Status:** ❌ Closed **Base:** `master` ← **Head:** `update-util-docstrings` --- ### 📝 Commits (4) - [`d5d2a06`](https://github.com/spotipy-dev/spotipy/commit/d5d2a06261922a429d7a4bc19f770a64af6ed0f2) Added function docstrings for util.py that includes arguments, returns, and raises. The prompt_for_user_token function docstring is revised for clarity. - [`1a2e039`](https://github.com/spotipy-dev/spotipy/commit/1a2e039115f66481dfeb9083fb7fbe6f0c124f7f) updating .gitignore and adding api credentials - [`d7ebb83`](https://github.com/spotipy-dev/spotipy/commit/d7ebb831890199ef1124a655e70bdcc0f7181798) Merge branch 'master' into update-util-docstrings - [`354c811`](https://github.com/spotipy-dev/spotipy/commit/354c811e22c88a788e98f12bcef716965d9475bc) Added function docstrings for util.py that includes arguments, returns, and raises. The prompt_for_user_token function docstring is revised for clarity. ### 📊 Changes **3 files changed** (+65 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+4 -1) 📝 `CHANGELOG.md` (+8 -0) 📝 `spotipy/util.py` (+53 -16) </details> ### 📄 Description Added function docstrings for util.py that include arguments, returns, and raises according to the standard styling guidelines. The prompt_for_user_token function docstring is revised for clarity—credits to dieser-niko for the helpful explanation of the functions. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-28 00:03:56 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/spotipy#1172
No description provided.